Struct tracery::Grammar

pub struct Grammar { /* fields omitted */ }

Represents a single grammar

This is the main data type used with this library.

Implementations

impl Grammar

pub fn new() -> Grammar

Create a new default Grammar

pub fn get_modifier(&self, modifier: &str) -> Option<&dyn Fn(&str) -> String>

Gets a single modifier with the given name, if it exists

pub fn get_rule(&self, key: &str) -> Option<&Vec<Rule>>

Gets a rule with the given key, if it exists

pub fn from_json<S: AsRef<str>>(s: S) -> Result<Grammar>

Creates a new grammar from a JSON grammar string

pub fn default_rule<S: Into<String>>(self, s: S) -> Grammar

Sets a default rule for the Grammar

Returns

The modified Grammar

pub fn add_rules<S: Into<String>>(
    &mut self,
    name: S,
    rules: Vec<Rule>
) -> Result<()>

Adds a rule with the given key and list of rules to the Grammar

Returns

Ok(()) on success Error otherwise

Trait Implementations

impl Default for Grammar

fn default() -> Grammar

Returns the "default value" for a type.

impl Flatten for Grammar

fn flatten(
    &self,
    _: &Grammar,
    overrides: &mut BTreeMap<String, String>
) -> Result<String>

Given a grammar and a set of overriden rules (from actions), produces a single "flattened" output string or an error