crypto-common: rename serializable_state module to hazmat
#1487
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tarcieri
force-pushed
the
crypto-common/move-serialize-traits-into-hazmat-module
branch
from
ac09483
to
9b41783
Compare
tarcieri
commented
Jan 26, 2024
| @@ -12,6 +12,9 @@ | |||
| #[cfg(feature = "std")] | |||
| extern crate std; | |||
|
|
|||
| /// Hazardous materials. | |||
There was a problem hiding this comment.
I put this here for now to avoid modifying the now hazmat.rs but it would be good to move the comment into there in a followup commit
|
Hmm, perhaps we should move the documentation checks into the "Workspace" workflow. Running |
newpavlov
approved these changes
Jan 26, 2024
|
I could potentially add a |
tarcieri
added a commit
that referenced
this pull request
Jan 27, 2024
This should fix the error we're encountering in #1487, and at the same time also check all crates have valid documentation, rather than just `elliptic-curve` and `signature`.
tarcieri
added a commit
that referenced
this pull request
Jan 27, 2024
This should fix the error we're encountering in #1487, and at the same time also check all crates have valid documentation, rather than just `elliptic-curve` and `signature`.
tarcieri
added a commit
that referenced
this pull request
Jan 27, 2024
Also removes the toplevel re-exports for the traits, forcing users to go
through the now `pub hazmat` module.
There's a lot of misuse potential with these traits, which are intended
to make it possible to serialize/deserialize the internal state of hash
functions. However previously they were presented side-by-side with
other traits, which made that unclear.
This commit deliberately doesn't make other changes to the file so git
will preserve its history:
diff --git a/crypto-common/src/serializable_state.rs b/crypto-common/src/hazmat.rs
similarity index 100%
rename from crypto-common/src/serializable_state.rs
rename to crypto-common/src/hazmat.rs
It would be very good for a followup commit to massively expand the
documentation around both the module and the traits, especially to spell
out the various ways they can be misused.
tarcieri
force-pushed
the
crypto-common/move-serialize-traits-into-hazmat-module
branch
from
9b41783
to
d0b8719
Compare
tarcieri
deleted the
crypto-common/move-serialize-traits-into-hazmat-module
branch
baloo
added a commit
to baloo/traits
that referenced
this pull request
Mar 17, 2024
tarcieri
pushed a commit
that referenced
this pull request
Mar 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also removes the toplevel re-exports for the traits, forcing users to go through the now
pub hazmatmodule.There's a lot of misuse potential with these traits, which are intended to make it possible to serialize/deserialize the internal state of hash functions. However previously they were presented side-by-side with other traits, which made that unclear.
This commit deliberately doesn't make other changes to the file so git will preserve its history:
It would be very good for a followup commit to massively expand the documentation around both the module and the traits, especially to spell out the various ways they can be misused.