Struct Key 

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

A 16-byte key used for NVS storage (15 characters + null terminator)

Implementations

impl Key

pub const fn from_array<const M: usize>(src: &[u8; M]) -> Self

Creates a 16 byte, null-padded byte array used as key for values and namespaces.

Usage: Key::from_array(b"my_key")

Tip: use a const context if possible to ensure that the key is transformed at compile time: let my_key = const { Key::from_array(b"my_key") };

pub const fn from_slice(src: &[u8]) -> Self

Creates a 16 byte, null-padded byte array used as key for values and namespaces.

Usage: Key::from_slice(b"my_key")

Tip: use a const context if possible to ensure that the key is transformed at compile time: let my_key = const { Key::from_slice("my_key".as_bytes()) };

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

Creates a 16 byte, null-padded byte array used as key for values and namespaces.

Usage: Key::from_str("my_key")

Tip: use a const context if possible to ensure that the key is transformed at compile time: let my_key = const { Key::from_str("my_key") };

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

Converts a key to a byte array.

pub fn as_str(&self) -> &str

Returns the key as a string slice, excluding null padding.

Trait Implementations

impl AsRef<[u8]> for Key

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

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

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Hash for Key

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 Key

fn cmp(&self, other: &Key) -> 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 Key

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

fn partial_cmp(&self, other: &Key) -> 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 Copy for Key

impl Eq for Key

impl StructuralPartialEq for Key