Skip to content
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

Jump to bottom

Document #[zeroize(skip)] in the zeroize crate #662

Merged
merged 3 commits into from Nov 10, 2021
Merged

Document #[zeroize(skip)] in the zeroize crate #662

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
997cdcb
Document `#[zeroize(skip)]` in the zeroize crate
daxpedda Nov 9, 2021
e22ede2
Document where attribute can be used
daxpedda Nov 10, 2021
beb959e
Fix indentation
daxpedda Nov 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions zeroize/src/lib.rs
View file
Open in desktop
Expand Up @@ -69,6 +69,7 @@
//! Additionally it supports the following attribute:
//!
//! - `#[zeroize(drop)]`: call `zeroize()` when this item is dropped
//! - `#[zeroize(skip)]`: skips this field or variant when calling `zeroize()`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would probably be good to note that drop is a type-level attribute and skip is a field-level attribute

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I separated them into different lists, I think it would go quiet well with #663. WDYT?

//!
//! Example which derives `Drop`:
//!
Expand Down