Add note on SerializableSecret about making it public

eopb · Jul 25, 2023 · 1afbb4a · 1afbb4a
1 parent 4d302e3
commit 1afbb4a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/serde.rs b/src/serde.rs
@@ -14,6 +14,10 @@ impl<'de, T: Deserialize<'de>> Deserialize<'de> for Secret<T> {
 ///
 /// This abstraction enables [expose_secret] to be used to serialize both `Secret<T>` and
 /// `Option<Secret<T>`.
+///
+/// This type is currently private. I would be interested in contributions that make it
+/// public. If you feel that using `SerializableSecret` could be useful for your use
+/// case please open a PR :)
 pub trait SerializableSecret<T> {
     type Exposed<'a>: Serialize
     where