Struct EffectRow 

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

Required handler keys and their effect families, ordered by key. Self::is_subset_of validates the requirements against handler descriptors.

Implementations

impl EffectRow

pub fn new() -> Self

An empty row.

pub fn insert( &mut self, key: HandlerKey, family: EffectFamily, ) -> Option<EffectFamily>

Name key as family; a key already named is re-named.

pub fn insert_if_absent(&mut self, key: HandlerKey, family: EffectFamily)

Name key as family unless the row already names it.

pub fn remove(&mut self, key: &HandlerKey) -> Option<EffectFamily>

Remove key from the row; the family it named, if it was there.

pub fn get(&self, key: &HandlerKey) -> Option<&EffectFamily>

The family the row names key as.

pub fn contains_key(&self, key: &HandlerKey) -> bool

Whether the row names key.

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

The keys, in order.

pub fn iter(&self) -> impl Iterator<Item = (&HandlerKey, &EffectFamily)>

The entries, in key order.

pub fn len(&self) -> usize

How many keys the row names.

pub fn is_empty(&self) -> bool

Whether the row names no key.

pub fn is_subset_of(&self, handlers: &[HandlerDescriptor]) -> Result<(), RowGap>

Validates that every key is served with the required family, returning the first gap in key order. Uses the first descriptor matching each key.

pub fn diff(&self, other: &EffectRow) -> Vec<RowDiff>

Returns missing and mismatched entries in this row’s key order, followed by extra entries in the other row’s key order.

Trait Implementations

impl Clone for EffectRow

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EffectRow

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

Formats the value using the given formatter.

impl Default for EffectRow

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EffectRow

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EffectRow

impl FromIterator<(HandlerKey, EffectFamily)> for EffectRow

fn from_iter<I: IntoIterator<Item = (HandlerKey, EffectFamily)>>( iter: I, ) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a EffectRow

type Item = (&'a HandlerKey, &'a EffectFamily)

The type of the elements being iterated over.

type IntoIter = Iter<'a, HandlerKey, EffectFamily>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for EffectRow

type Item = (HandlerKey, EffectFamily)

The type of the elements being iterated over.

type IntoIter = IntoIter<HandlerKey, EffectFamily>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for EffectRow

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EffectRow

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 EffectRow