Struct Sequence 

pub struct Sequence { /* private fields */ }

Sequence.

Sequences are ordered collections of expressions that can be used to match identifiers. Sequences can contain gaps, which allow to implement flexible matching of identifiers with varying numbers of elements, including but not limited to prefix and suffix matching.

Each Element of a Sequence can either be an Expression or a Gap. An Expression is a logical combination of one or multiple Id and Selector instances, while a Gap represents a wildcard that can match any number of elements, including zero.

The following convenience constructors are provided:

• Sequence::prefix: Creates a sequence for prefix matching.
• Sequence::suffix: Creates a sequence for suffix matching.

Examples

use zrx_id::{selector, Sequence};

// Create sequence
let sequence = Sequence::from([
    selector!(location = "zensical.toml")?,
    selector!(location = "**/*.md")?,
]);

Implementations

impl Sequence

pub fn prefix<T>(sequence: T) -> Self

where T: Into<Self>,

Creates a sequence where the given elements are a prefix.

Examples

use zrx_id::{selector, Sequence};

// Create sequence for a prefix
let sequence = Sequence::prefix([
    selector!(location = "zensical.toml")?,
]);

pub fn suffix<T>(sequence: T) -> Self

where T: Into<Self>,

Creates a sequence where the given elements are a suffix.

Examples

use zrx_id::{selector, Sequence};

// Create sequence for a suffix
let sequence = Sequence::suffix([
    selector!(location = "**/*.md")?,
]);

pub fn iter(&self) -> Iter<'_, Element>

Creates an iterator over the sequence.

Examples

use zrx_id::{selector, Sequence};

// Create sequence
let sequence = Sequence::from([
    selector!(location = "zensical.toml")?,
    selector!(location = "**/*.md")?,
]);

// Create iterator over sequence
for element in sequence.iter() {
    println!("{element:?}");
}

impl Sequence

pub fn len(&self) -> usize

Returns the number of elements.

pub fn is_empty(&self) -> bool

Returns whether there are any elements.

Trait Implementations

impl Clone for Sequence

fn clone(&self) -> Sequence

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sequence

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

Formats the value using the given formatter.

impl Default for Sequence

fn default() -> Self

Creates a sequence that matches everything.

Examples

use zrx_id::Sequence;

// Create empty sequence
let sequence = Sequence::default();
assert!(!sequence.is_empty());

impl Eq for Sequence

impl<E> From<&[E]> for Sequence

where E: Into<Element> + Clone,

fn from(value: &[E]) -> Self

Creates a sequence from a slice of elements.

Examples

use zrx_id::{selector, Sequence};

// Create sequence
let sequence = Sequence::from(&[
    selector!(location = "zensical.toml")?,
    selector!(location = "**/*.md")?,
][..]);

impl<E> From<E> for Sequence

where E: Into<Element>,

fn from(value: E) -> Self

Creates a sequence from an element.

Examples

use zrx_id::{selector, Sequence};

// Create sequence
let sequence = Sequence::from(
    selector!(location = "zensical.toml")?,
);

impl<E> From<Vec<E>> for Sequence

where E: Into<Element>,

fn from(value: Vec<E>) -> Self

Creates a sequence from a vector of elements.

Examples

use zrx_id::{selector, Sequence};

// Create sequence
let sequence = Sequence::from(vec![
    selector!(location = "zensical.toml")?,
    selector!(location = "**/*.md")?,
]);

impl<E, const N: usize> From<[E; N]> for Sequence

where E: Into<Element>,

fn from(value: [E; N]) -> Self

Creates a sequence from a slice of elements.

Examples

use zrx_id::{selector, Sequence};

// Create sequence
let sequence = Sequence::from([
    selector!(location = "zensical.toml")?,
    selector!(location = "**/*.md")?,
]);

impl<E> FromIterator<E> for Sequence

where E: Into<Element>,

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = E>,

Creates a sequence from an iterator.

Examples

use zrx_id::{selector, Sequence};

// Create sequence from iterator
let sequence = Sequence::from_iter([
    selector!(location = "zensical.toml")?,
    selector!(location = "**/*.md")?,
]);

impl<'a> IntoIterator for &'a Sequence

fn into_iter(self) -> Self::IntoIter

Creates an iterator over the sequence.

Examples

use zrx_id::{selector, Sequence};

// Create sequence
let sequence = Sequence::from([
    selector!(location = "zensical.toml")?,
    selector!(location = "**/*.md")?,
]);

// Create iterator over sequence
for element in &sequence {
    println!("{element:?}");
}

type Item = &'a Element

The type of the elements being iterated over.

type IntoIter = Iter<'a, Element>

Which kind of iterator are we turning this into?

impl IntoIterator for Sequence

fn into_iter(self) -> Self::IntoIter

Creates a consuming iterator over the sequence.

Examples

use zrx_id::{selector, Sequence};

// Create sequence
let sequence = Sequence::from([
    selector!(location = "zensical.toml")?,
    selector!(location = "**/*.md")?,
]);

// Create iterator over sequence
for element in sequence {
    println!("{element:?}");
}

type Item = Element

The type of the elements being iterated over.

type IntoIter = IntoIter<<Sequence as IntoIterator>::Item>

Which kind of iterator are we turning this into?

impl PartialEq for Sequence

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Sequence

impl ToSpecificity for Sequence

fn to_specificity(&self) -> Specificity

Computes the specificity of the sequence.

Examples

use zrx_id::selector;
use zrx_id::sequence::Sequence;
use zrx_id::specificity::ToSpecificity;

// Create sequence and compute specificity
let sequence = Sequence::from(selector!(location = "**/*.md")?);
assert_eq!(sequence.to_specificity(), (0, 1, 1, 3).into());

impl Value for Sequence