fix: Make SecretString public (#5269)

* fix: make secret string public Signed-off-by: Lohachov Mykhailo <[email protected]> * fix: Update crates/iroha/src/secrecy.rs Co-authored-by: Shunkichi Sato <[email protected]> Signed-off-by: Mykhailo Lohachov <[email protected]> --------- Signed-off-by: Lohachov Mykhailo <[email protected]> Signed-off-by: Mykhailo Lohachov <[email protected]> Co-authored-by: Shunkichi Sato <[email protected]>
hyperledger-iroha · Dec 12, 2024 · d512102 · d512102
1 parent f32a775
commit d512102
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/crates/iroha/src/lib.rs b/crates/iroha/src/lib.rs
@@ -5,7 +5,7 @@ pub mod config;
 pub mod http;
 mod http_default;
 pub mod query;
-mod secrecy;
+pub mod secrecy;
 
 pub use iroha_crypto as crypto;
 pub use iroha_data_model as data_model;

diff --git a/crates/iroha/src/secrecy.rs b/crates/iroha/src/secrecy.rs
@@ -1,12 +1,15 @@
+//! Types for representing securely printable secrets.
 use std::fmt;
 
 use derive_more::Constructor;
 use serde::{Deserialize, Serialize, Serializer};
 
+/// String sensitive to printing and serialization
 #[derive(Clone, Deserialize, Constructor)]
 pub struct SecretString(String);
 
 impl SecretString {
+    /// Returns underlying secret string
     pub fn expose_secret(&self) -> &str {
         &self.0
     }