Struct Stamp 

pub struct Stamp { /* private fields */ }

The complete declared payload one published stamp is rendered from: the name it is exported under, the pattern it stamps, and every site that adopts it.

Bounds

Structurally non-empty — a definition nobody invokes is an artifact with no reader — and the site namespace is closed at declaration, because two rows naming one site is a manifest that says one thing twice. Every site’s arguments are settled against the pattern here rather than left to the consumer’s compiler, which would report a mismatch inside an expansion nobody wrote.

Implementations

impl Stamp

pub fn declared( name: StampName, pattern: Pattern, sites: Vec<Site>, ) -> Result<Self, StampError>

Declare the complete payload one published stamp is rendered from.

Errors

Returns StampError::SiteNameDoubled where two sites carry one name, StampError::ArgumentsUnmatched where a site supplies a different number of arguments than the pattern declares seats, StampError::ReachUnseated where a site declares a reach the pattern gives no coordinate to, StampError::SitesAbsent where no site was stated, and StampError::SitesUnbounded where the sites outgrow the declared magnitude.

The namespace is closed first, then each site is settled against the pattern in the order the sites were stated, and the magnitude last.

pub const fn name(&self) -> &StampName

The name this stamp is exported under.

pub const fn pattern(&self) -> &Pattern

The pattern this stamp stamps.

pub fn sites(&self) -> &NonEmpty<Site, SITE_LIMIT>

The sites covered, in the order they were declared; structurally at least one.

Ordering

This order is meaning for a migration: one invocation is rendered per site in the order this yields.

pub fn count(&self) -> usize

How many sites this stamp covers; structurally at least one.

Trait Implementations

impl Clone for Stamp

fn clone(&self) -> Stamp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Stamp

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

Formats the value using the given formatter.

impl Eq for Stamp

impl Hash for Stamp

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 Stamp

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Stamp