Struct KeyedRoster 

pub struct KeyedRoster<T, K, const N: usize> { /* private fields */ }

A non-empty bounded roster whose caller-declared keys are unique.

Implementations

impl<T, K, const N: usize> KeyedRoster<T, K, N>

pub const fn one(member: T, key: K) -> Self

A roster containing one member under its caller-declared key.

pub const fn first(&self) -> &T

The first member, which this roster always has.

pub const fn first_key(&self) -> &K

The key retained for the first member.

pub fn count(&self) -> usize

How many members are held, which is never zero.

pub fn members(&self) -> impl Iterator<Item = &T>

Reads the members in declaration order.

pub fn keys(&self) -> impl Iterator<Item = &K>

Reads the retained keys in declaration order.

pub fn indexed(&self) -> impl Iterator<Item = (usize, &K, &T)>

Reads every declaration index, retained key, and member together.

pub fn at(&self, index: usize) -> Option<(&K, &T)>

Reads the key and member at one checked declaration index.

pub fn index_of<Q>(&self, sought: &Q) -> Option<usize>

where K: Borrow<Q>, Q: Eq + ?Sized,

Finds the declaration index of one borrowed key.

pub fn get<Q>(&self, sought: &Q) -> Option<&T>

where K: Borrow<Q>, Q: Eq + ?Sized,

Finds the member held under one borrowed key.

pub fn indexed_get<Q>(&self, sought: &Q) -> Option<(usize, &K, &T)>

where K: Borrow<Q>, Q: Eq + ?Sized,

Finds the declaration position, retained key, and member under one borrowed key.

impl<T, K: Eq, const N: usize> KeyedRoster<T, K, N>

pub fn new( members: Vec<T>, key_of: impl FnMut(&T) -> K, ) -> Result<Self, KeyedRosterError<K, N>>

Admits one complete ordered offering under caller-declared unique keys.

The offering’s nonempty bounded magnitude is settled before the key projection runs.

Errors

Returns Empty when nothing is offered, Overflow when more than N items are offered, and DuplicateKey coordinates for every distinct key that occurs more than once.

Trait Implementations

impl<T: Clone, K: Clone, const N: usize> Clone for KeyedRoster<T, K, N>

fn clone(&self) -> KeyedRoster<T, K, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, K: Debug, const N: usize> Debug for KeyedRoster<T, K, N>

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

Formats the value using the given formatter.

impl<T: Eq, K: Eq, const N: usize> Eq for KeyedRoster<T, K, N>

impl<T: Hash, K: Hash, const N: usize> Hash for KeyedRoster<T, K, 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<T: PartialEq, K: PartialEq, const N: usize> PartialEq for KeyedRoster<T, K, N>

fn eq(&self, other: &KeyedRoster<T, K, N>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq, K: PartialEq, const N: usize> StructuralPartialEq for KeyedRoster<T, K, N>