Enum hayagriva::Selector

#[non_exhaustive]
pub enum Selector {
    Wildcard,
    Entry(EntryType),
    Neg(Box<Self>),
    Binding(String, Box<Self>),
    Attr(Box<Self>, Vec<String>),
    Alt(Vec<Self>),
    Multi(Vec<Self>),
    Ancestrage(Box<Self>, Box<Self>),
}

A selector used to filter bibliographies and match on entries.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Wildcard

A wildcard selector: *.

Entry(EntryType)

An entry type literal: report.

Neg(Box<Self>)

A negation: !x.

Binding(String, Box<Self>)

A binding: x:misc.

Attr(Box<Self>, Vec<String>)

An attribute filtering: abc[att1, attr2].

Alt(Vec<Self>)

An alternate selector: a | b.

Multi(Vec<Self>)

A multi-parent selector: a & b.

Ancestrage(Box<Self>, Box<Self>)

An ancestrage selector: a > b.

Implementations

impl Selector

pub fn parse(src: &str) -> Result<Self, SelectorError>

Parse a selector from a string.

pub fn matches(&self, entry: &Entry) -> bool

Checks if the selector matches the provided Entry.

pub fn bound<'s>(&self, entry: &'s Entry, bound: &str) -> Option<&'s Entry>

Applies the selector and returns the bound element if there was a match.

This can panic if there are resolving entries which do not bind the argument.

pub fn apply<'s>(&self, entry: &'s Entry) -> Option<HashMap<String, &'s Entry>>

Applies the selector to an Entry and returns the bound variables in a hash map if there was a match.

Trait Implementations

impl Clone for Selector

fn clone(&self) -> Selector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Selector

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

Formats the value using the given formatter.

impl PartialEq for Selector

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Selector

impl StructuralPartialEq for Selector