Struct SecretKey

pub struct SecretKey<const N: usize>(/* private fields */);

Represents a secret key used with transport encryption and authentication

Implementations

impl<const N: usize> SecretKey<N>

pub fn unprotected_as_bytes(&self) -> &[u8]

Returns byte slice to the key’s bytes

pub fn unprotected_as_byte_array(&self) -> &[u8; N]

Returns reference to array of key’s bytes

pub fn unprotected_into_byte_array(self) -> [u8; N]

Consumes the secret key and returns the array of key’s bytes

pub fn into_heap_secret_key(self) -> HeapSecretKey

Consumes the secret key and returns the key’s bytes as a HeapSecretKey

pub fn len(&self) -> usize

Returns the length of the key

pub fn generate() -> Result<Self, SecretKeyError>

Generates a new secret key, returning success if key created or failing if the desired key length is not between 1 and isize::MAX

pub fn from_slice(slice: &[u8]) -> Result<Self, SecretKeyError>

Creates the key from the given byte slice, returning success if key created or failing if the byte slice does not match the desired key length

Trait Implementations

impl<const N: usize> Clone for SecretKey<N>

fn clone(&self) -> SecretKey<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for SecretKey<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for SecretKey<N>

fn default() -> Self

Creates a new secret key of the size N

Panic

Will panic if N is less than 1 or greater than isize::MAX

impl<const N: usize> Display for SecretKey<N>

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

Display an N-byte secret key as a hex string

impl<const N: usize> From<[u8; N]> for SecretKey<N>

fn from(arr: [u8; N]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<SecretKey<N>> for HeapSecretKey

fn from(key: SecretKey<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> FromStr for SecretKey<N>

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a str of hex as an N-byte secret key

type Err = SecretKeyError

The associated error which can be returned from parsing.

impl<const N: usize> PartialEq for SecretKey<N>

fn eq(&self, other: &SecretKey<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const N: usize> Eq for SecretKey<N>

impl<const N: usize> StructuralPartialEq for SecretKey<N>