Struct sodiumoxide::crypto::secretbox::xsalsa20poly1305::Key

pub struct Key(pub [u8; 32]);

Key for symmetric authenticated encryption

When a Key goes out of scope its contents will be zeroed out

Implementations

impl Key

pub fn from_slice(bs: &[u8]) -> Option<Key>

from_slice() creates an object from a byte slice

This function will fail and return None if the length of the byte-slice isn’t equal to the length of the object

Trait Implementations

impl AsRef<[u8]> for Key

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Key

fn deserialize<D>(deserializer: D) -> Result<Key, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Drop for Key

fn drop(&mut self)

Executes the destructor for this type.

impl Index<Range<usize>> for Key

Allows a user to access the byte contents of an object as a slice.

WARNING: it might be tempting to do comparisons on objects by using x[a..b] == y[a..b]. This will open up for timing attacks when comparing for example authenticator tags. Because of this only use the comparison functions exposed by the sodiumoxide API.

type Output = [u8]

The returned type after indexing.

fn index(&self, _index: Range<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for Key

Allows a user to access the byte contents of an object as a slice.

WARNING: it might be tempting to do comparisons on objects by using x[a..] == y[a..]. This will open up for timing attacks when comparing for example authenticator tags. Because of this only use the comparison functions exposed by the sodiumoxide API.

type Output = [u8]

The returned type after indexing.

fn index(&self, _index: RangeFrom<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for Key

Allows a user to access the byte contents of an object as a slice.

WARNING: it might be tempting to do comparisons on objects by using x[] == y[]. This will open up for timing attacks when comparing for example authenticator tags. Because of this only use the comparison functions exposed by the sodiumoxide API.

type Output = [u8]

The returned type after indexing.

fn index(&self, _index: RangeFull) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for Key

Allows a user to access the byte contents of an object as a slice.

WARNING: it might be tempting to do comparisons on objects by using x[..b] == y[..b]. This will open up for timing attacks when comparing for example authenticator tags. Because of this only use the comparison functions exposed by the sodiumoxide API.

type Output = [u8]

The returned type after indexing.

fn index(&self, _index: RangeTo<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl PartialEq<Key> for Key

fn eq(&self, other: &Key) -> bool

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

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

This method tests for !=.

impl Serialize for Key

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Key