milksad
/
rust-secp256k1-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Improve rustdocs for displaying secrets 

Improve rustdocs on `display_secret` by doing:

- Minor improvements to the rustdocs to aid readability in the editor.
- Do not guarantee (`assert_eq!`) debug output
This commit is contained in:
Tobin Harding 2022-02-18 12:09:42 +00:00
parent 5c7c76eb74
commit e4be664d97
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
1 changed files with 15 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/secret.rs
View File

@ -113,27 +113,26 @@ impl SecretKey {
/// little-endian hexadecimal string using the provided formatter. /// little-endian hexadecimal string using the provided formatter.
/// ///
/// This is the only method that outputs the actual secret key value, and, thus, /// This is the only method that outputs the actual secret key value, and, thus,
/// should be used with extreme precaution. /// should be used with extreme caution.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// # #[cfg(all(feature = "std", not(feature = "bitcoin_hashes")))] { /// # #[cfg(feature = "std")] {
/// use secp256k1::ONE_KEY; /// let key = secp256k1::ONE_KEY;
/// let key = ONE_KEY; ///
/// // Normal display hides value /// // Normal debug hides value (`Display` is not implemented for `SecretKey`).
/// assert_eq!( /// // E.g., `format!("{:?}", key)` prints "SecretKey(#2518682f7819fb2d)".
/// "SecretKey(#2518682f7819fb2d)", ///
/// format!("{:?}", key)
/// );
/// // Here we explicitly display the secret value: /// // Here we explicitly display the secret value:
/// assert_eq!( /// assert_eq!(
/// "0000000000000000000000000000000000000000000000000000000000000001", /// "0000000000000000000000000000000000000000000000000000000000000001",
/// format!("{}", key.display_secret()) /// format!("{}", key.display_secret())
/// ); /// );
/// // Also, we can explicitly display with `Debug`:
/// assert_eq!( /// assert_eq!(
/// "DisplaySecret(\"0000000000000000000000000000000000000000000000000000000000000001\")", /// format!("{:?}", key.display_secret()),
/// format!("{:?}", key.display_secret()) /// format!("DisplaySecret(\"{}\")", key.display_secret())
/// ); /// );
/// # } /// # }
/// ``` /// ```
@ -153,7 +152,7 @@ impl KeyPair {
/// # Example /// # Example
/// ///
/// ``` /// ```
/// # #[cfg(all(feature = "std", not(feature = "bitcoin_hashes")))] { /// # #[cfg(feature = "std")] {
/// use secp256k1::ONE_KEY; /// use secp256k1::ONE_KEY;
/// use secp256k1::KeyPair; /// use secp256k1::KeyPair;
/// use secp256k1::Secp256k1; /// use secp256k1::Secp256k1;
@ -161,20 +160,15 @@ impl KeyPair {
/// let secp = Secp256k1::new(); /// let secp = Secp256k1::new();
/// let key = ONE_KEY; /// let key = ONE_KEY;
/// let key = KeyPair::from_secret_key(&secp, key); /// let key = KeyPair::from_secret_key(&secp, key);
///
/// // Normal display hides value
/// assert_eq!(
/// "KeyPair(#2518682f7819fb2d)",
/// format!("{:?}", key)
/// );
/// // Here we explicitly display the secret value: /// // Here we explicitly display the secret value:
/// assert_eq!( /// assert_eq!(
/// "0000000000000000000000000000000000000000000000000000000000000001", /// "0000000000000000000000000000000000000000000000000000000000000001",
/// format!("{}", key.display_secret()) /// format!("{}", key.display_secret())
/// ); /// );
/// // Also, we can explicitly display with `Debug`:
/// assert_eq!( /// assert_eq!(
/// "DisplaySecret(\"0000000000000000000000000000000000000000000000000000000000000001\")", /// format!("{:?}", key.display_secret()),
/// format!("{:?}", key.display_secret()) /// format!("DisplaySecret(\"{}\")", key.display_secret())
/// ); /// );
/// # } /// # }
/// ``` /// ```