Struct DecoratorSet 

pub struct DecoratorSet { /* private fields */ }

An immutable set of decorators.

The decorators of a level compose in a defined order, by order and then by id, each one decorating what the one before it produced; DecoratorSet::add and DecoratorSet::remove return new sets, so removing a decorator gives exactly the output of the set without it.

Implementations

impl DecoratorSet

pub fn new(decorators: Vec<Decorator>) -> Result<Self, DecoratorError>

A set of decorators, sorted by order and then by id.

Errors

A DecoratorError when two decorators share an id.

pub const fn empty() -> Self

The set without decorators.

pub fn from_lino(text: &str) -> Result<Self, DecoratorError>

Reads the decorators of a Links Notation document (see DecoratorSet::to_lino).

Errors

A DecoratorError for text that is not Links Notation or a statement that is not a valid decorator.

pub fn decorators(&self) -> &[Decorator]

The decorators, in the order they compose.

pub const fn len(&self) -> usize

The number of decorators.

pub const fn is_empty(&self) -> bool

Whether the set has no decorator.

pub fn ids(&self) -> Vec<&str>

The ids, in the order the decorators compose.

pub fn add( &self, decorators: impl IntoIterator<Item = Decorator>, ) -> Result<Self, DecoratorError>

The set with decorators added.

Errors

A DecoratorError when an id is taken.

pub fn remove(&self, id: &str) -> Result<Self, DecoratorError>

The set without the decorator id.

Errors

A DecoratorError when the set has no decorator id.

pub fn for_level( &self, level: DecoratorLevel, ) -> impl Iterator<Item = &Decorator>

The decorators of level, in the order they compose.

pub fn has(&self, level: DecoratorLevel) -> bool

Whether the set has a decorator of level.

pub fn decorate( &self, level: DecoratorLevel, record: &DecoratorRecord, ) -> Option<DecoratorRecord>

The record the decorators of level make of record, or None when one of them drops it. A missing field reads as empty text.

pub fn decorate_all( &self, level: DecoratorLevel, records: &[DecoratorRecord], ) -> Vec<DecoratorRecord>

Decorates every record of records, leaving out the dropped ones.

pub fn to_lino(&self) -> String

The canonical Links Notation of the set, one decorator per line.

Trait Implementations

impl Clone for DecoratorSet

fn clone(&self) -> DecoratorSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecoratorSet

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

Formats the value using the given formatter.

impl Default for DecoratorSet

fn default() -> DecoratorSet

Returns the “default value” for a type.

impl Eq for DecoratorSet

impl PartialEq for DecoratorSet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DecoratorSet