Struct orion::hazardous::stream::xchacha20::Nonce

pub struct Nonce { /* private fields */ }

A type that represents a Nonce that XChaCha20, XChaCha20-Poly1305 use.

Errors:

An error will be returned if:

• slice is not 24 bytes.

Panics:

A panic will occur if:

• Failure to generate random bytes securely.

Implementations

impl Nonce

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

Construct from a given byte slice.

pub fn generate() -> Nonce

Randomly generate using a CSPRNG. Not available in no_std context.

pub fn len(&self) -> usize

Return the length of the object.

pub fn is_empty(&self) -> bool

Return true if this object does not hold any data, false otherwise.

NOTE: This method should always return false, since there shouldn’t be a way to create an empty instance of this object.

Trait Implementations

impl AsRef<[u8]> for Nonce

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

Converts this type into a shared reference of the (usually inferred) input type.

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 Debug for Nonce

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

Formats the value using the given formatter.

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

Available on crate feature serde only.

This type tries to deserialize as a Vec<u8> would. If it succeeds, the digest will be built using Self::from_slice.

Note that this allocates once to store the referenced bytes on the heap.

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

Deserialize this value from the given Serde deserializer.

impl From<[u8; 24]> for Nonce

fn from(bytes: [u8; 24]) -> Nonce

Make an object from a byte array.

impl PartialEq<&[u8]> for Nonce

fn eq(&self, other: &&[u8]) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Nonce> for Nonce

fn eq(&self, other: &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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Nonce

Available on crate feature serde only.

This type tries to serialize as a &[u8] would. Note that the serialized type likely does not have the same protections that Orion provides, such as constant-time operations. A good rule of thumb is to only serialize these types for storage. Don’t operate on the serialized types.

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

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for Nonce

Delegates to from_slice implementation

type Error = UnknownCryptoError

The type returned in the event of a conversion error.

fn try_from(slice: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Nonce

impl Eq for Nonce