Struct Block 

pub struct Block {
    header: String,
    fields: Vec<(String, String)>,
}

One parsed parity block.

Fields

header: String

Line 1, verbatim, version included.

fields: Vec<(String, String)>

The key: value lines after the header, in printed order.

Implementations

impl Block

pub fn parse(source: &str, origin: &str) -> Result<Self, Error>

Parses the block out of everything source printed.

The block is the last thing an example prints, so the scan starts at the last header line and everything above it is ignored — an example is free to print a reader-friendly summary first.

Errors

Error::Arm naming origin when there is no block, when a line is not key: value with exactly one space after the colon, when a key repeats, when a required key is absent, or when the best.param.* lines are not last and ascending. Every one of those is a printer that does not meet §17.4, and a lenient parser here would turn a broken printer into a green gate.

pub fn render(&self) -> String

The block’s canonical text: the header, the fields, one trailing newline.

A round trip through parse is the identity on a valid block, which is what lets a golden be written from a parsed block and re-read without normalisation.

pub fn len(&self) -> usize

How many fields the block carries, for the progress line.

fn check_shape(&self, origin: &str) -> Result<(), Error>

Enforces the parts of §17.4 that are properties of the whole block.

Trait Implementations

impl Clone for Block

fn clone(&self) -> Block

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Block

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

Formats the value using the given formatter.

impl Eq for Block

impl PartialEq for Block

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Block