Struct bellframe::place_not::PnBlock

pub struct PnBlock { /* fields omitted */ }

A contiguous block of PlaceNots.

Implementations

impl PnBlock

pub fn parse(s: &str, stage: Stage) -> Result<Self, PnBlockParseError>

Parse a string slice into a PnBlock, checking for ambiguity and correctness. This also expands symmetric blocks and implicit places.

pub fn from_iter(
    iter: impl IntoIterator<Item = PlaceNot>
) -> Result<Self, InvalidPnBlockError>

Creates a new PnBlock from an Iterator of PlaceNots, checking that the resulting PnBlock is valid (i.e. all the stages match and the PnBlock contains at least one PlaceNot).

pub fn from_vec(pns: Vec<PlaceNot>) -> Result<Self, InvalidPnBlockError>

Creates a new PnBlock from a Vec of PlaceNots, checking that the resulting PnBlock is valid (i.e. all the stages match and the PnBlock contains at least one PlaceNot).

pub unsafe fn from_vec_unchecked(pns: Vec<PlaceNot>) -> Self

Creates a new PnBlock from a Vec of PlaceNots, without checking that the resulting PnBlock is valid.

Safety

This is only safe if:

• All the Stages of the PlaceNots match
• The Vec is non-empty

pub fn place_nots(&self) -> Iter<'_, PlaceNot>

Returns an iterator over the PlaceNots contained in this PnBlock

pub fn stage(&self) -> Stage

The Stage of this PnBlock.

pub fn len(&self) -> usize

The number of PlaceNots in this PnBlock. This is also the len of any Block generated by applying this PnBlock to some Row.

pub fn to_block<A: Default>(&self) -> AnnotBlock<A>

Generates a Block specified by these PlaceNots. This Block will contain only default annotations.

Trait Implementations

impl Clone for PnBlock

fn clone(&self) -> PnBlock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PnBlock

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

Formats the value using the given formatter.

impl Hash for PnBlock

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<PnBlock> for PnBlock

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

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

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

This method tests for !=.

impl Eq for PnBlock

impl StructuralEq for PnBlock

impl StructuralPartialEq for PnBlock