Skip to content

Mark Key::from_bytes as safe #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jamesmunns merged 2 commits into from
Jun 19, 2025
Merged

Mark Key::from_bytes as safe #236

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59115cd
Make `Key::from_bytes` as safe
Veykril Jun 13, 2025
a1b66ae
Update source/postcard-schema/src/key/mod.rs
jamesmunns Jun 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions source/postcard-schema/src/key/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,13 @@ impl Key {
Key(hash::fnv1a64::hash_ty_path::<T>(path))
}

/// Unsafely create a key from a given 8-byte value
/// Create a key from a given 8-byte value
Comment thread
jamesmunns marked this conversation as resolved.
///
/// ## Safety
///
/// This MUST only be used with pre-calculated values. Incorrectly
/// created keys could lead to the improper deserialization of
/// messages.
pub const unsafe fn from_bytes(bytes: [u8; 8]) -> Self {
/// NOTE: Since [`Key`]s should never be used to replace full type safety,
/// creating a "wrong" Key should not be unsafe. However, using a "wrong"
/// key (which doesn't match the type being deserialized) may cause confusion,
/// so manually creating keys should be avoided whenever possible.
pub const fn from_bytes(bytes: [u8; 8]) -> Self {
Self(bytes)
}

Expand Down