Struct FieldList 

pub struct FieldList {
    pub line: usize,
    /* private fields */
}

The ordered fields in effect for a run of records (§5).

Fields

line: usize

1-based source line of the !fields line (0 when synthesised).

Implementations

impl FieldList

pub fn new(fields: Vec<FieldDecl>) -> FieldList

Build a field list, precomputing its arity.

No validation is performed here; parse_lines rejects duplicate names and the other §11.1 conditions while reading the !fields line.

pub fn source(&self) -> &str

The !fields line exactly as it appeared in the document, trimmed of surrounding whitespace — empty for a programmatically built list.

A tool that splits or concatenates documents (§15.3) has to re-emit the field list in effect at the split point; replaying the original bytes keeps the shards byte-identical to the source, which re-deriving the declaration from FieldList::fields would not (§14 normalises the separator to ; and drops the author’s spacing).

pub fn fields(&self) -> &[FieldDecl]

Declarations in source order, block fields included.

pub fn arity(&self) -> usize

Number of fields without the block flag — the expected count of inline parts per record (§5.3).

pub fn get(&self, name: &str) -> Option<&FieldDecl>

Look a declaration up by exact name.

Trait Implementations

impl Clone for FieldList

fn clone(&self) -> FieldList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldList

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

Formats the value using the given formatter.

impl PartialEq for FieldList

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FieldList