Struct HeapSecretKey

pub struct HeapSecretKey(/* private fields */);

Represents a secret key used with transport encryption and authentication that is stored on the heap

Implementations

impl HeapSecretKey

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

Returns byte slice to the key’s bytes

pub fn unprotected_into_bytes(self) -> Vec<u8>

Consumes the secret key and returns the key’s bytes

pub fn len(&self) -> usize

Returns the length of the key

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

Generates a random key of n bytes in length.

Note

Will return an error if n < 1 or n > isize::MAX.

Trait Implementations

impl Clone for HeapSecretKey

fn clone(&self) -> HeapSecretKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeapSecretKey

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

Formats the value using the given formatter.

impl Display for HeapSecretKey

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 HeapSecretKey

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 From<Vec<u8>> for HeapSecretKey

fn from(bytes: Vec<u8>) -> Self

Converts to this type from the input type.

impl FromStr for HeapSecretKey

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

Parse a str of hex as secret key on heap

type Err = SecretKeyError

The associated error which can be returned from parsing.

impl PartialEq<[u8]> for HeapSecretKey

fn eq(&self, other: &[u8]) -> 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> PartialEq<[u8; N]> for HeapSecretKey

fn eq(&self, other: &[u8; 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 PartialEq<HeapSecretKey> for &[u8]

fn eq(&self, other: &HeapSecretKey) -> 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> PartialEq<HeapSecretKey> for &[u8; N]

fn eq(&self, other: &HeapSecretKey) -> 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 PartialEq<HeapSecretKey> for &String

fn eq(&self, other: &HeapSecretKey) -> 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 PartialEq<HeapSecretKey> for &str

fn eq(&self, other: &HeapSecretKey) -> 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 PartialEq<HeapSecretKey> for [u8]

fn eq(&self, other: &HeapSecretKey) -> 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> PartialEq<HeapSecretKey> for [u8; N]

fn eq(&self, other: &HeapSecretKey) -> 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 PartialEq<HeapSecretKey> for String

fn eq(&self, other: &HeapSecretKey) -> 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 PartialEq<HeapSecretKey> for str

fn eq(&self, other: &HeapSecretKey) -> 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 PartialEq<String> for HeapSecretKey

fn eq(&self, other: &String) -> 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 PartialEq<str> for HeapSecretKey

fn eq(&self, other: &str) -> 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 PartialEq for HeapSecretKey

fn eq(&self, other: &HeapSecretKey) -> 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 Eq for HeapSecretKey

impl StructuralPartialEq for HeapSecretKey