Struct ProductionString

pub struct ProductionString { /* private fields */ }

Represents strings in our L-system. Strings are made up of a list of Symbol objects.

If you would like to parse an instance of this struct from a string, you can use parser::parse_prod_string, like so:

use rusty_systems::parser;
let axiom = parser::parse_prod_string("Forward Forward Forward").unwrap();

Implementations

impl ProductionString

pub fn new() -> Self

Create an empty string

pub fn empty() -> Self

Creates an / the empty production string. This is a synonym for ProductionString::new.

pub fn is_empty(&self) -> bool

Whether the production string is empty or not. i.e., whether this is the empty string.

pub fn len(&self) -> usize

Returns the length of the production string.

pub fn symbols(&self) -> &Vec<Symbol>

Access the symbols of this production string.

pub fn push_symbol(&mut self, symbol: Symbol)

Add another symbol to the end of the string.

pub fn iter(&self) -> Iter<'_, Symbol>

Iterate over the symbols.

Trait Implementations

impl Clone for ProductionString

fn clone(&self) -> ProductionString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProductionString

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

Formats the value using the given formatter.

impl Default for ProductionString

fn default() -> Self

Returns the “default value” for a type.

impl Display for ProductionString

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

Formats the value using the given formatter.

impl From<Symbol> for ProductionString

fn from(value: Symbol) -> Self

Converts to this type from the input type.

impl From<Vec<Symbol>> for ProductionString

fn from(value: Vec<Symbol>) -> Self

Converts to this type from the input type.

impl Hash for ProductionString

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<usize> for ProductionString

type Output = Symbol

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a ProductionString

type Item = Symbol

The type of the elements being iterated over.

type IntoIter = Cloned<Iter<'a, <&'a ProductionString as IntoIterator>::Item>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for ProductionString

type Item = Symbol

The type of the elements being iterated over.

type IntoIter = IntoIter<<ProductionString as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for ProductionString

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SymbolIterable for ProductionString

fn all_symbols_iter(&self) -> impl Iterator<Item = Symbol>

Iterate over all symbols contained in the object.

fn all_symbols<C: FromIterator<Symbol>>(&self) -> C

Creates a collection of all the symbols that [self.all_symbols_iter] iterates over.

impl Eq for ProductionString

impl StructuralPartialEq for ProductionString