Struct rust_sodium::crypto::secretbox::xsalsa20poly1305::Nonce

#[must_use]
pub struct Nonce(pub [u8; 24]);

Nonce for symmetric authenticated encryption

Methods

impl Nonce

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

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

fn increment_le(&self) -> Nonce

increment_le() treats the nonce as an unsigned little-endian number and returns an incremented version of it.

WARNING: this method does not check for arithmetic overflow. It is the callers responsibility to ensure that any given nonce value is only used once. If the caller does not do that the cryptographic primitives in rust_sodium will not uphold any security guarantees (i.e. they will break)

fn increment_le_inplace(&mut self)

increment_le_inplace() treats the nonce as an unsigned little-endian number and increments it.

WARNING: this method does not check for arithmetic overflow. It is the callers responsibility to ensure that any given nonce value is only used once. If the caller does not do that the cryptographic primitives in rust_sodium will not uphold any security guarantees.

Trait Implementations

impl Copy for Nonce

impl Clone for Nonce

fn clone(&self) -> Nonce

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for Nonce

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

impl Serialize for Nonce

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Nonce

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

Deserialize this value from the given Serde deserializer.

impl Index<Range<usize>> for Nonce

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 rust_sodium API.

type Output = [u8]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for Nonce

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 rust_sodium API.

type Output = [u8]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for Nonce

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 rust_sodium 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 Nonce

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 rust_sodium API.

type Output = [u8]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl AsRef<[u8]> for Nonce

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

Performs the conversion.

impl PartialOrd for Nonce

fn partial_cmp(&self, other: &Nonce) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Nonce) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Nonce) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn ge(&self, other: &Nonce) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

fn gt(&self, other: &Nonce) -> bool

This method tests greater than (for self and other) and is used by the > operator.

impl Ord for Nonce

fn cmp(&self, other: &Nonce) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Hash for Nonce

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for Nonce

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

Formats the value using the given formatter.