Document #[zeroize(skip)] in the zeroize crate
#662
Merged
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
reviewed
Nov 9, 2021
zeroize/src/lib.rs
Outdated
Comment on lines
71
to
72
| //! - `#[zeroize(drop)]`: call `zeroize()` when this item is dropped | ||
| //! - `#[zeroize(skip)]`: skips this field or variant when calling `zeroize()` |
There was a problem hiding this comment.
It would probably be good to note that drop is a type-level attribute and skip is a field-level attribute
There was a problem hiding this comment.
I separated them into different lists, I think it would go quiet well with #663. WDYT?
|
Looks good, thanks |
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.
This actually documents the
#[zeroize(skip)]functionality in the zeroize crate, until now it was only documented in thezeroize_derivecrate.