Struct bevy_generative_grammars::tracery::StatefulStringGenerator

pub struct StatefulStringGenerator(_);

This is a stateful string generator based on the tracery grammar. Note that since it is stateful, it does support variables.

Implementations

impl StatefulStringGenerator

pub fn new<T: Clone + Into<String>>( rules: &[(T, &[T])], starting_point: Option<T> ) -> Self

This provides a new stateful generating using tracery grammar. You provide a set of rules as (Key, &[Values]) and optionally a starting point. If no starting point is provided, we fall back on “origin”

pub fn clone_grammar(grammar: &TraceryGrammar) -> Self

This creates a new stateful string generator by cloning an existing tracery grammar.

pub fn from_grammar(grammar: TraceryGrammar) -> Self

This creates a stateful generator wrapping an existing grammar.

Trait Implementations

impl Clone for StatefulStringGenerator

fn clone(&self) -> StatefulStringGenerator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for StatefulStringGeneratorwhere Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either [TableStorage] or [SparseStorage].

impl Debug for StatefulStringGenerator

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

Formats the value using the given formatter.

impl StatefulGenerator<String, String, String, TraceryGrammar> for StatefulStringGenerator

fn generate<R: GrammarRandomNumberGenerator>( &mut self, rng: &mut R ) -> Option<String>

This function generates a new value of StreamType, starting from the grammar’s default rule

fn generate_at<R: GrammarRandomNumberGenerator>( &mut self, key: &String, rng: &mut R ) -> Option<String>

This function generates a new value of StreamType, starting from a provided rule key

fn expand_from<R: GrammarRandomNumberGenerator>( &mut self, initial: &String, rng: &mut R ) -> String

This function generates a new value of StreamType, starting by processing an initial input of StreamType

fn set_grammar(&mut self, grammar: &TraceryGrammar)

This sets the used grammar

fn get_grammar(&self) -> &TraceryGrammar

This gets an immutable reference to the grammar

fn get_grammar_mut(&mut self) -> &mut TraceryGrammar

This gets a mutable reference to the grammar

impl Resource for StatefulStringGeneratorwhere Self: Send + Sync + 'static,