From 997cdcb64c724b938f2d4ea136b9f036ed6df2b4 Mon Sep 17 00:00:00 2001 From: daxpedda Date: Tue, 9 Nov 2021 15:49:08 +0100 Subject: [PATCH 1/3] Document `#[zeroize(skip)]` in the zeroize crate --- zeroize/src/lib.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/zeroize/src/lib.rs b/zeroize/src/lib.rs index 28ee5420..5e2fd741 100644 --- a/zeroize/src/lib.rs +++ b/zeroize/src/lib.rs @@ -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()` //! //! Example which derives `Drop`: //! From e22ede2fc8c06c1f5a91c37907236862e696e3dc Mon Sep 17 00:00:00 2001 From: daxpedda Date: Wed, 10 Nov 2021 09:13:53 +0100 Subject: [PATCH 2/3] Document where attribute can be used --- zeroize/derive/src/lib.rs | 13 +++++++------ zeroize/src/lib.rs | 5 ++++- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/zeroize/derive/src/lib.rs b/zeroize/derive/src/lib.rs index 6c61f2f2..4301449b 100644 --- a/zeroize/derive/src/lib.rs +++ b/zeroize/derive/src/lib.rs @@ -14,13 +14,14 @@ decl_derive!( /// Derive the `Zeroize` trait. /// - /// Supports the following attribute: + /// Supports the following attributes: /// - /// - `#[zeroize(drop)]`: derives the `Drop` trait, calling `zeroize()` - /// when this item is dropped. - /// - `#[zeroize(skip)]`: skips this field or variant when calling - /// `zeroize()`. - derive_zeroize + /// On the item level: + /// - `#[zeroize(drop)]`: call `zeroize()` when this item is dropped + /// + /// On the field level: + /// - `#[zeroize(skip)]`: skips this field or variant when calling `zeroize()` +derive_zeroize ); /// Name of zeroize-related attributes diff --git a/zeroize/src/lib.rs b/zeroize/src/lib.rs index 5e2fd741..3af212da 100644 --- a/zeroize/src/lib.rs +++ b/zeroize/src/lib.rs @@ -66,9 +66,12 @@ //! which automatically calls `zeroize()` on all members of a struct //! or tuple struct. //! -//! Additionally it supports the following attribute: +//! Additionally it supports the following attributes: //! +//! On the item level: //! - `#[zeroize(drop)]`: call `zeroize()` when this item is dropped +//! +//! On the field level: //! - `#[zeroize(skip)]`: skips this field or variant when calling `zeroize()` //! //! Example which derives `Drop`: From beb959e65966af09fa08666ea4d787620de7ee7e Mon Sep 17 00:00:00 2001 From: daxpedda Date: Wed, 10 Nov 2021 09:19:15 +0100 Subject: [PATCH 3/3] Fix indentation --- zeroize/derive/src/lib.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zeroize/derive/src/lib.rs b/zeroize/derive/src/lib.rs index 4301449b..fc4e1a5b 100644 --- a/zeroize/derive/src/lib.rs +++ b/zeroize/derive/src/lib.rs @@ -21,7 +21,7 @@ decl_derive!( /// /// On the field level: /// - `#[zeroize(skip)]`: skips this field or variant when calling `zeroize()` -derive_zeroize + derive_zeroize ); /// Name of zeroize-related attributes