From e825219e9df9409f52d1a4d53131188fa92979a5 Mon Sep 17 00:00:00 2001 From: Ethan Brierley Date: Sat, 11 May 2024 10:11:37 +0100 Subject: [PATCH] docs: update for `SerializableSecret` This type was unintentionally made public in https://github.com/eopb/redact/pull/46 Since that was a few releases ago, I think it'd be probably best to keep it public.i `redact` attempts to be stable, I don't want to risk breaking any code. --- src/serde.rs | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/src/serde.rs b/src/serde.rs index fbdbc38..63230e1 100644 --- a/src/serde.rs +++ b/src/serde.rs @@ -12,11 +12,8 @@ impl<'de, T: Deserialize<'de>> Deserialize<'de> for Secret { /// A serializable type that contains a secret. /// -/// This abstraction enables [expose_secret] to be used to serialize both `Secret` and -/// `Option>`. -/// -/// This type is currently private. If you feel that a public `SerializableSecret` could -/// be useful for your use case please open a PR :) +/// This abstraction enables [expose_secret] to be used to serialize both `Secret`, `&Secret` +/// and `Option>`. pub trait SerializableSecret { type Exposed<'a>: Serialize where