Struct Key 

pub struct Key { /* private fields */ }

A 256-bit FLOE key that zeroizes its owned bytes on drop.

Use Key::generate for a fresh random key or Key::from_bytes when importing existing key material.

Implementations

impl Key

pub const LEN: usize = 32

Required FLOE key length in bytes.

pub fn generate() -> Result<Self>

Generates a new 256-bit FLOE key with the build default provider.

Errors

Returns Error::ProviderSelectionRequired when multiple providers are compiled, or Error::RngFailure if the provider cannot obtain secure randomness.

pub fn generate_with_provider(provider: Provider) -> Result<Self>

Generates a new 256-bit FLOE key bound to provider.

Errors

Returns Error::RngFailure if the provider cannot obtain secure randomness.

pub const fn from_bytes(bytes: [u8; 32]) -> Self

Imports an existing 256-bit key using the build default provider.

Provider resolution is deferred until Self::provider or the first cryptographic operation.

pub const fn from_bytes_with_provider( bytes: [u8; 32], provider: Provider, ) -> Self

Imports an existing 256-bit key bound to provider.

pub const fn as_bytes(&self) -> &[u8; 32]

Returns the raw secret key bytes. Handle with care.

pub const fn provider(&self) -> Result<Provider>

Returns the concrete provider this key will use.

Errors

Returns Error::ProviderSelectionRequired when this key has no explicit provider and multiple providers are compiled.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Key

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Key

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<[u8; 32]> for Key

fn from(bytes: [u8; 32]) -> Self

Converts to this type from the input type.

impl TryFrom<&[u8]> for Key

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self>

Performs the conversion.