Struct Modes 

pub struct Modes<const N: usize> { /* private fields */ }

A canonical packet of ordered mode values.

N is the maximum number of modes and must be greater than zero.

The high bit indicates that another mode follows, and trailing zero-valued modes are omitted. Appending a new mode with value zero therefore preserves the existing encoding. A Modes value denotes a present packet. An all-zero list denotes no packet.

Examples

use commonware_codec::{DecodeExt, Encode, Modes, mode};

let modes = Modes::new([mode!(1), mode!(0), mode!(2)]).unwrap();
let encoded = modes.encode();
assert_eq!(encoded.as_ref(), &[0x81, 0x80, 0x02]);
assert_eq!(Modes::<3>::decode(encoded).unwrap(), modes);

use commonware_codec::Modes;

let _ = Modes::<0>::new([]);

Implementations

impl<const N: usize> Modes<N>

pub fn new(modes: [Mode; N]) -> Option<Self>

Creates a canonical packet from modes.

Returns None when every mode is zero. Callers must represent this as an absent packet rather than an empty packet.

Trait Implementations

impl<const N: usize> Clone for Modes<N>

fn clone(&self) -> Modes<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Copy for Modes<N>

impl<const N: usize> Debug for Modes<N>

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

Formats the value using the given formatter.

impl<const N: usize> EncodeSize for Modes<N>

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

fn encode_inline_size(&self) -> usize

Returns the encoded size excluding bytes passed to BufsMut::push during Write::write_bufs. Used to size the working buffer for inline writes. Override alongside Write::write_bufs for types where large Bytes fields go via push; failing to do so will over-allocate.

impl<const N: usize> Eq for Modes<N>

impl<const N: usize> Hash for Modes<N>

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<const N: usize> PartialEq for Modes<N>

fn eq(&self, other: &Modes<N>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<const N: usize> Read for Modes<N>

type Cfg = ()

The Cfg type parameter allows passing configuration during the read process. This is crucial for safely decoding untrusted data, for example, by providing size limits for collections or strings.

fn read_cfg(buf: &mut impl Buf, _: &()) -> Result<Self, Error>

Reads a value from the buffer using the provided configuration cfg.

impl<const N: usize> StructuralPartialEq for Modes<N>

impl<const N: usize> Write for Modes<N>

fn write(&self, buf: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

fn write_bufs(&self, buf: &mut impl BufsMut)

Writes to a BufsMut, allowing existing Bytes chunks to be appended via BufsMut::push instead of written inline. Must encode to the same format as Write::write. Defaults to Write::write.