Struct Pattern 

pub struct Pattern { /* private fields */ }

One authored pattern: what the definition is documented with, the shape it is invoked in, and the body that shape expands into.

Authority

The body is the caller’s token material and nothing here reads it. It names seats by the names the shape declares them under, and the two reaches by the names this home publishes. A body naming anything else is a defect the consumer’s own compiler reports at the site that adopted it, because a producer that checked it would be legislating a meaning it does not own.

Implementations

impl Pattern

pub fn declared( note: &str, parts: Vec<Part>, body: GeneratedTree, ) -> Result<Self, StampError>

Declare one pattern: the sentence its definition is documented with, the shape it is invoked in, and the body that shape expands into.

Errors

Returns StampError::SeatNameDoubled where two seats carry one name, StampError::PatternEmpty where no part was stated, and StampError::PatternUnbounded where the parts outgrow the declared magnitude.

The namespace is closed before the magnitude, because a collision is a defect in what was declared and a caller repairing a magnitude first would repair the collision second.

pub fn note(&self) -> &str

The sentence the definition is documented with.

pub fn parts(&self) -> &NonEmpty<Part, PART_LIMIT>

The declared shape, in the order it is written; structurally at least one part.

Ordering

This order is meaning: a matcher and every invocation are walks over it, so the same parts stated in another order are another grammar.

pub const fn body(&self) -> &GeneratedTree

The body the shape expands into.

pub fn seats(&self) -> impl Iterator<Item = &Seat>

The seats of the shape, in the order a site supplies arguments for them.

pub fn seat_count(&self) -> usize

How many seats the shape declares.

pub fn reaches(&self) -> bool

Whether the shape gives a site’s visibility a coordinate.

Trait Implementations

impl Clone for Pattern

fn clone(&self) -> Pattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pattern

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

Formats the value using the given formatter.

impl Eq for Pattern

impl Hash for Pattern

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Pattern

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Pattern