Struct bevy_generative_grammars::tracery::TraceryGrammar

pub struct TraceryGrammar { /* private fields */ }

This is a grammar that handles rules provided in a tracery syntax. See - https://github.com/galaxykate/tracery for more info on Tracery.

Implementations

impl TraceryGrammar

pub fn empty() -> Self

This provides an empty tracery grammar. Mostly used for handling stateless generators.

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

This provides a new 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”

Trait Implementations

impl Clone for TraceryGrammar

fn clone(&self) -> TraceryGrammar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for TraceryGrammarwhere 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 TraceryGrammar

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TraceryGrammar

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Generator<String, String, String, TraceryGrammar> for StringGenerator

fn generate<R: GrammarRandomNumberGenerator>( grammar: &TraceryGrammar, 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>( key: &String, grammar: &TraceryGrammar, rng: &mut R ) -> Option<String>

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

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

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

impl Grammar<String, String, String> for TraceryGrammar

fn rule_keys(&self) -> &Vec<String>

Gets a Vec of all the possible rule keys - can be used to see if any match

fn has_rule(&self, rule: &String) -> bool

Checks if a given rule key is available

fn default_starting_point(&self) -> &String

Gets the default starting key - used if no other key is set

fn get_rule_options(&self, rule: &String) -> Option<&Vec<String>>

Gets all the possible expansions from a rule key

fn check_token_stream( &self, stream: &String ) -> (bool, Vec<Replacable<String, String>>)

Parses a token stream and determines a) whether there are any tokens to replace and b) if so, which The bool is true if there are no more tokens that need replacing

fn rule_to_default_result(&self, rule: &String) -> String

Converts a rule key to a default result, in case no matching rule is found in the grammar.

fn processing_direction(&self) -> GrammarProcessingDirection

determines if the grammar should be processed breadth-first or depth-first

fn result_to_stream(&self, result: &[String]) -> String

Converts a group of result types to a stream type

fn set_additional_rules(&mut self, rule: String, values: &[String])

This is a function for setting a new rule. The expectation is that it overrides the original.

fn stream_to_result(&self, stream: &String) -> Vec<String>

Converts a stream to a vec of result type

fn select_from_rule<R: GrammarRandomNumberGenerator>( &self, rule: &RuleKeyType, rng: &mut R ) -> Option<&ResultType>

Selects an element from a rule’s options. provides a default implementation in case no weighting is ncessessary. The RNG function should accept the total number of options, and return a single id (a number less than the total). If it is larger, we will use the last element.

fn copy_and_replace_rules(&mut self, other: &Self)

This is used to clone all the roles from another grammar into this one. This is used by stateful generators to update their state.

fn max_depth(&self) -> usize

Provides the maximum depth (number of iterations) allowed for the generator. It will always quit early if it stabilizes, but otherwise it will conclude when it reaches the provided depth.

fn process_stream<R: GrammarRandomNumberGenerator>( &self, stream: &StreamType, rng: &mut R, temporary_grammar: &mut Self ) -> StreamType

Takes a token stream, checks it for replacements, and then applies them by using select from rule. It returns a bool indicating whether it had to make any replacements this round, and a vec of the results.

fn breadth_first_processing<R: GrammarRandomNumberGenerator>( &self, stream: &StreamType, temporary_grammar: &mut Self, rng: &mut R ) -> StreamType

Processes a stream breadth first, regardless of the settings of the grammar

fn depth_first_processing<R: GrammarRandomNumberGenerator>( &self, stream: &StreamType, temporary_grammar: &mut Self, rng: &mut R ) -> StreamType

Processes a stream depth first, regardless of the settings of the grammar

impl Serialize for TraceryGrammar

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

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 TypePath for TraceryGrammar

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl TypeUuid for TraceryGrammar

const TYPE_UUID: Uuid = _

impl VisitAssetDependencies for TraceryGrammar

fn visit_dependencies(&self, _visit: &mut impl FnMut(UntypedAssetId))

impl Asset for TraceryGrammar

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