Struct distant_core::SecretKey

source · [−]

pub struct SecretKey<const N: usize>(_);

Expand description

Represents a secret key used with transport encryption and authentication

Implementations

source

impl<const N: usize> SecretKey<N>

source

pub fn unprotected_as_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Returns byte slice to the key’s bytes

source

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

Returns reference to array of key’s bytes

source

pub fn len(&self) -> usize

Returns the length of the key

source

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

source

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

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

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

source

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

source

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

Converts to this type from the input type.

source

impl From<SecretKey<32_usize>> for XChaCha20Poly1305Codec

source

fn from(secret_key: SecretKey32) -> Self

Create a new XChaCha20Poly1305 codec with a 32-byte key

source

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

type Err = SecretKeyError

The associated error which can be returned from parsing.

source

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

Parses a string s to return a value of this type. Read more

source

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

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct distant_core::SecretKey

Implementations

impl<const N: usize> SecretKey<N>

pub fn unprotected_as_bytes(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

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

pub fn len(&self) -> usize

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

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

Trait Implementations

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

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

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

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

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

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

fn default() -> Self

Panic

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

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

impl From<SecretKey<32_usize>> for XChaCha20Poly1305Codec

fn from(secret_key: SecretKey32) -> Self

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

type Err = SecretKeyError

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

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

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

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

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

fn unprotected_to_hex_key(&self) -> String

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

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

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

pub fn unprotected_as_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,