Struct Nonce 

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

Implementations

impl Nonce

pub const fn new(nonce: [u8; 32]) -> Self

Creates a new Nonce directly from a NONCE_LEN-byte array.

This is the most direct way to create a Nonce when you already have a properly sized NONCE_LEN-byte array. No padding or hashing is performed.

Examples

let bytes = [1u8; 32];
let nonce = Nonce::new(bytes);
assert_eq!(nonce.as_bytes(), &bytes);

pub const fn from_short_str(s: &str) -> Self

Creates a Nonce from a string slice at compile time.

If the string is shorter than NONCE_LEN bytes, it is padded with zeros. If the string is longer than NONCE_LEN bytes, it is truncated to NONCE_LEN bytes.

Note: This behavior matches From<&str> for strings up to NONCE_LEN bytes. For longer strings, From<&str> would perform a Blake3 hash instead of truncation.

Examples

const CONNECT: Nonce = Nonce::from_short_str("connect");

pub fn as_bytes(&self) -> &[u8; 32]

Returns a reference to the inner NONCE_LEN-byte array.

This method is useful when you need to access the raw bytes of the nonce, for example when using it as a seed for PDA derivation.

Examples

let nonce = Nonce::from("example");
let bytes = nonce.as_bytes();
// Use bytes for PDA derivation or other operations

Trait Implementations

impl BorshDeserialize for Nonce

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for Nonce

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for Nonce

fn clone(&self) -> Nonce

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Nonce

impl Debug for Nonce

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

Formats the value using the given formatter.

impl Default for Nonce

fn default() -> Nonce

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Nonce

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

Formats the Nonce as a hexadecimal string.

This implementation converts the NONCE_LEN-byte nonce to a 64-character hexadecimal string representation, which is useful for logging, debugging, and serialization to human-readable formats.

Examples

let nonce = Nonce::from([1u8; 32]);
let hex_string = nonce.to_string();
println!("Nonce: {}", nonce); // Prints the hex representation

impl Eq for Nonce

impl From<&String> for Nonce

fn from(nonce: &String) -> Self

Creates a Nonce from a reference to a String.

This implementation is similar to the owned String implementation, converting the string to bytes and applying the standard rules.

Examples

let nonce = Nonce::from(&String::from("account:user123"));

impl From<&Vec<u8>> for Nonce

fn from(nonce: &Vec<u8>) -> Self

Creates a Nonce from a reference to a vector of bytes.

This implementation converts the vector to a slice and applies the same padding/hashing rules as the slice implementation.

Examples

let vec = vec![1, 2, 3, 4];
let nonce = Nonce::from(vec.as_slice());

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

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

Creates a Nonce from a reference to a fixed-size byte array of any length.

Behavior

• If N > NONCE_LEN: The input is hashed using Blake3 to produce a NONCE_LEN-byte nonce
• If N <= NONCE_LEN: The input is padded with zeros to reach NONCE_LEN bytes

The padding is applied to the right side, preserving the original bytes at the beginning.

Examples

// Small array (padded)
let small = [1, 2, 3, 4];
let nonce_small = Nonce::from(&small);

// Large array (hashed)
let large = [1u8; 64];
let nonce_large = Nonce::from(&large);

impl From<&[u8]> for Nonce

fn from(nonce: &[u8]) -> Self

Creates a Nonce from a byte slice of any length.

This implementation handles dynamic-length byte slices, applying the same logic as the fixed-size array implementation:

Behavior

• If nonce.len() > NONCE_LEN: The input is hashed using Blake3
• If nonce.len() <= NONCE_LEN: The input is padded with zeros

Edge Cases

• Empty slice: Results in a nonce of all zeros
• Exactly NONCE_LEN bytes: No transformation is applied, but the bytes are copied

Examples

// Empty slice
let empty: &[u8] = &[];
let nonce_empty = Nonce::from(empty);
assert_eq!(*nonce_empty.as_bytes(), [0u8; 32]);

// Dynamic slice
let data = b"dynamic length data".to_vec();
let nonce_dynamic = Nonce::from(data.as_slice());

impl From<&str> for Nonce

fn from(nonce: &str) -> Self

Creates a Nonce from a string slice.

This implementation converts the string to bytes and then applies the standard padding/hashing rules. This is particularly useful for creating deterministic nonces from human-readable identifiers.

Examples

let nonce = Nonce::from("account:user123");

Note

String-based nonces are convenient but be aware that:

• Different string encodings could produce different nonces
• Unicode strings may have unexpected byte representations

impl From<String> for Nonce

fn from(nonce: String) -> Self

Creates a Nonce from an owned String.

This implementation converts the String to bytes and applies the same padding/hashing rules as the string slice implementation.

Examples

let nonce = Nonce::from(String::from("account:user123"));

impl From<Vec<u8>> for Nonce

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

Creates a Nonce from an owned vector of bytes.

This implementation converts the vector to a slice and applies the same padding/hashing rules as the slice implementation.

Examples

let vec = vec![1, 2, 3, 4];
let nonce = Nonce::from(vec);

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

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

Creates a Nonce from an owned fixed-size byte array.

This implementation delegates to the reference implementation to avoid code duplication. The same padding or hashing rules apply as in the reference implementation.

Examples

let array = [5u8; 16];
let nonce = Nonce::from(array);

impl From<u64> for Nonce

fn from(nonce: u64) -> Self

Creates a Nonce from a u64 integer.

The integer is converted to bytes in little-endian format before being padded to NONCE_LEN bytes. This is useful for creating sequential or indexed nonces.

Examples

// Create sequential nonces
let nonce1 = Nonce::from(1u64);
let nonce2 = Nonce::from(2u64);

Note

Since u64 is 8 bytes, the resulting nonce will always be padded rather than hashed. The first 8 bytes will contain the little-endian representation of the integer, and the remaining 24 bytes will be zeros.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Nonce

fn eq(&self, other: &Nonce) -> 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 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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

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