Struct Field 

pub struct Field<'a> { /* private fields */ }

A field of a node kind: a label its children carry, the kinds it can hold, and how many (see Language::fields).

Examples

use lang_forge::{Cardinality, Language};

let lang = Language::from_lsf(
    "[sketch]\nformat = 2\n[language]\nname = \"x\"\nversion = \"1.0.0\"\n\
     [rules]\npair = \"key:IDENT '=' value:(NUMBER | IDENT)\"\n",
)?;
let pair = lang.kind("pair").expect("a rule");
let value = lang.fields(pair).find(|f| f.name() == "value").expect("labelled");
assert_eq!(value.cardinality(), Cardinality::One);
let kinds: Vec<&str> = value.kinds().map(|k| lang.kind_name(k)).collect();
assert_eq!(kinds, ["IDENT", "NUMBER"]);
assert_eq!(lang.label_name(value.label()), Some("value"));

Implementations

impl<'a> Field<'a>

pub fn label(&self) -> u16

The label’s id (see Language::label_id).

pub fn name(&self) -> &'a str

The label’s name.

pub fn cardinality(&self) -> Cardinality

How many children the field holds.

pub fn kinds(&self) -> impl Iterator<Item = Kind> + 'a

The kinds the field’s children can have, in index order.

Trait Implementations

impl<'a> Clone for Field<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Field<'a>

impl<'a> Debug for Field<'a>

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

Formats the value using the given formatter.