Enum Shape 

pub enum Shape {
    Text(Text),
    Template(LineTemplate),
    Pattern(Regex),
}

A unit’s shape.

Variants

Text(Text)

text: what the text must equal, or the frontmatter key whose value it must equal.

Template(LineTemplate)

template: the text written with typed holes.

Pattern(Regex)

pattern: a regex the text must match somewhere.

Implementations

impl Shape

pub fn regex(&self) -> Option<&Regex>

The shape’s regex, whose named groups are the keys it can capture; none for text.

pub fn matches( &self, text: &str, value: impl Fn(&str) -> Option<String>, ) -> bool

Whether text, squashed, has this shape. value resolves a { from: <key> } text to the frontmatter value, squashed.

pub fn captures<'t>(&self, text: &'t str) -> Option<Captures<'t>>

The groups the shape captures from text.

pub fn has_group(&self, name: &str) -> bool

Whether the shape holds a group named name.

pub fn failure(&self, text: &str) -> String

Why text does not have this shape, as a finding continues a sentence that opens with the text: does not match … or fails at column …. text names the shape of a literal.

pub fn reach(&self, text: &str) -> usize

How far into text the shape matched before it failed, for the furthest-failure choice between shapes: a template and a text know, a regex does not.

pub fn label(&self) -> String

The shape as a finding or a label names it.

Trait Implementations

impl Clone for Shape

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 Shape

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

Formats the value using the given formatter.