Skip to content

Commit 9e87901

Browse files
authored
crypto-common: rename Generate::*generate_from_rng (#2145)
Renames the following `Generate` methods: - `try_from_rng` => `try_generate_from_rng` - `from_rng` => `generate_from_rng` As I was writing impls of the `Generate` trait, I though it would be more consistent if all of the methods had `*generate*` in their name. This isn't too far off from what I had originally proposed in RustCrypto/meta#19.
1 parent af052ce commit 9e87901

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

crypto-common/src/generate.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ use crate::RngError;
77
/// Secure random generation.
88
pub trait Generate: Sized {
99
/// Generate random key using the provided [`TryCryptoRng`].
10-
fn try_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error>;
10+
fn try_generate_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error>;
1111

1212
/// Generate random key using the provided [`CryptoRng`].
13-
fn from_rng<R: CryptoRng + ?Sized>(rng: &mut R) -> Self {
14-
let Ok(ret) = Self::try_from_rng(rng);
13+
fn generate_from_rng<R: CryptoRng + ?Sized>(rng: &mut R) -> Self {
14+
let Ok(ret) = Self::try_generate_from_rng(rng);
1515
ret
1616
}
1717

@@ -22,7 +22,7 @@ pub trait Generate: Sized {
2222
/// Returns [`RngError`] in the event the system's ambient RNG experiences an internal failure.
2323
#[cfg(feature = "getrandom")]
2424
fn try_generate() -> Result<Self, RngError> {
25-
Self::try_from_rng(&mut sys_rng::SysRng)
25+
Self::try_generate_from_rng(&mut sys_rng::SysRng)
2626
}
2727

2828
/// Randomly generate a value of this type using the system's ambient cryptographically secure
@@ -41,21 +41,21 @@ pub trait Generate: Sized {
4141

4242
impl Generate for u32 {
4343
#[inline]
44-
fn try_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error> {
44+
fn try_generate_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error> {
4545
rng.try_next_u32()
4646
}
4747
}
4848

4949
impl Generate for u64 {
5050
#[inline]
51-
fn try_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error> {
51+
fn try_generate_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error> {
5252
rng.try_next_u64()
5353
}
5454
}
5555

5656
impl<const N: usize> Generate for [u8; N] {
5757
#[inline]
58-
fn try_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error> {
58+
fn try_generate_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error> {
5959
let mut ret = [0u8; N];
6060
rng.try_fill_bytes(&mut ret)?;
6161
Ok(ret)
@@ -64,7 +64,7 @@ impl<const N: usize> Generate for [u8; N] {
6464

6565
impl<U: ArraySize> Generate for Array<u8, U> {
6666
#[inline]
67-
fn try_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error> {
67+
fn try_generate_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error> {
6868
let mut ret = Self::default();
6969
rng.try_fill_bytes(&mut ret)?;
7070
Ok(ret)
@@ -73,14 +73,14 @@ impl<U: ArraySize> Generate for Array<u8, U> {
7373

7474
impl<U: ArraySize> Generate for Array<u32, U> {
7575
#[inline]
76-
fn try_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error> {
76+
fn try_generate_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error> {
7777
Self::try_from_fn(|_| rng.try_next_u32())
7878
}
7979
}
8080

8181
impl<U: ArraySize> Generate for Array<u64, U> {
8282
#[inline]
83-
fn try_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error> {
83+
fn try_generate_from_rng<R: TryCryptoRng + ?Sized>(rng: &mut R) -> Result<Self, R::Error> {
8484
Self::try_from_fn(|_| rng.try_next_u64())
8585
}
8686
}

0 commit comments

Comments
 (0)