Struct Keys 

pub struct Keys { /* private fields */ }

Names for the positions on one axis. A position may have no name. The names that are present are unique.

Implementations

impl Keys

pub fn partial(names: Vec<Option<Arc<str>>>) -> Result<Arc<Keys>, Error>

Keys from names, where None marks a position with no name. A Domain error when a name appears twice.

pub fn names(&self) -> &[Option<Arc<str>>]

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn complete(&self) -> bool

Whether every position has a name.

pub fn blank(&self) -> bool

Whether no position has a name. An axis like that carries no keys.

pub fn position(&self, name: &str) -> Option<usize>

pub fn extend(&mut self, names: &[Option<Arc<str>>]) -> Result<(), Error>

Adds positions at the end, named by names. A Domain error, with no position added, when a name is already here or appears twice in names.

pub fn align(&self, wanted: &Keys) -> Vec<Option<usize>>

For each position of wanted, the matching position here. Named positions match by name. Unnamed positions match in order.

pub fn positions( &self, wanted: &Keys, subset: bool, ) -> Result<Vec<usize>, Error>

For each position of wanted, the matching position here. With subset, wanted may have fewer positions, and one with no match is an Index error. Otherwise both need the same positions, and a mismatch is a Length error.

pub fn select( &self, positions: impl IntoIterator<Item = Option<usize>>, ) -> Result<Arc<Keys>, Error>

Keys at source positions, in the order given. A position with no source has no name.

pub fn aligned(self: &Arc<Keys>, wanted: &Arc<Keys>) -> Alignment

How these positions lie along those of wanted: as the same positions, at its first positions, or as Keys::align finds them.

pub fn union( self: &Arc<Keys>, other: &Arc<Keys>, ) -> Result<(Arc<Keys>, [Alignment; 2]), Error>

These positions, then the named positions of other that these lack, with how these positions and other’s lie along them. Unnamed positions pair in order. Both sides need the same number of them.

Trait Implementations

impl Clone for Keys

fn clone(&self) -> Keys

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keys

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

Formats the value using the given formatter.

impl Default for Keys

fn default() -> Keys

Returns the “default value” for a type.

impl Eq for Keys

impl PartialEq for Keys

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

Equality operator ==.

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

Inequality operator !=.