[−][src]Struct orion::auth::SecretKey
A type to represent a secret key.
As default it will randomly generate a SecretKey
of 32 bytes.
Note:
Due to the return type of the Default trait, the default()
method cannot let the caller
handle a failing CSPRNG. If the CSPRNG fails, that function panics. If handling a failing CSPRNG's
error is needed, use instead generate()
.
Exceptions:
An exception will be thrown if:
slice
is empty.- The
OsRng
fails to initialize or read from its source. length
is 0.length
is not less thanu32::max_value()
.
Security:
- Avoid using
unprotected_as_bytes()
whenever possible, as it breaks all protections that the type implements.
Methods
impl SecretKey
[src]
#[must_use]
pub fn from_slice(slice: &[u8]) -> Result<SecretKey, UnknownCryptoError>
[src]
Make an object from a given byte slice.
#[must_use]
pub fn unprotected_as_bytes(&self) -> &[u8]
[src]
Return the object as byte slice. Warning: Should not be used unless strictly needed. This breaks protections that the type implements.
pub fn get_length(&self) -> usize
[src]
Return the length of the object.
#[must_use]
pub fn generate(length: usize) -> Result<SecretKey, UnknownCryptoError>
[src]
Randomly generate using a CSPRNG. Not available in no_std
context.
Trait Implementations
impl Default for SecretKey
[src]
#[must_use]
fn default() -> SecretKey
[src]
Randomly generate using a CSPRNG with recommended size. Not available in no_std
context.
impl PartialEq<SecretKey> for SecretKey
[src]
fn eq(&self, other: &SecretKey) -> bool
[src]
#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl Drop for SecretKey
[src]
impl Debug for SecretKey
[src]
Auto Trait Implementations
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From for T
[src]
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,