fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-05-30 03:01:21 +00:00
Code Issues Projects Releases Wiki Activity

Restore a comment with doctest

Browse Source
This commit is contained in:
Ivan Boldyrev 2023-10-03 21:56:26 +04:00
parent 866cc1a21a
commit 2fe25c725c
1 changed files with 14 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
identity/src/keypair.rs
View File

@ -343,36 +343,20 @@ impl Keypair {
}
}
#[doc = r##"
Deterministically derive a new secret from this [`Keypair`], taking into account the provided domain.
This works for all key types except RSA where it returns `None`.
# Example
"##]
#[cfg_attr(
feature = "rand",
doc = r##"
```
"##
)]
#[cfg_attr(
not(feature = "rand"),
doc = r##"
```ignore
"##
)]
#[doc = r##"
# fn main() {
# use libp2p_identity as identity;
let key = identity::Keypair::generate_ed25519();
let new_key = key.derive_secret(b"my encryption key").expect("can derive secret for ed25519");
# }
```
"##
]
/// Deterministically derive a new secret from this [`Keypair`], taking into account the provided domain.
///
/// This works for all key types except RSA where it returns `None`.
///
/// # Example
///
/// ```
/// # fn main() {
/// # use libp2p_identity as identity;
/// let key = identity::Keypair::generate_ed25519();
///
/// let new_key = key.derive_secret(b"my encryption key").expect("can derive secret for ed25519");
/// # }
/// ```
#[allow(unused_variables, unreachable_code)]
pub fn derive_secret(&self, domain: &[u8]) -> Option<[u8; 32]> {
#[cfg(any(