Struct throne::State

pub struct State { /* fields omitted */ }

Stores a set of Phrases.

Implementations

impl State

pub fn remove(&mut self, id: PhraseId)

Removes a phrase by PhraseId.

pub fn remove_phrase(&mut self, phrase: &Phrase) -> bool

Removes the first occurrence of phrase from the state.

Returns false if the phrase could not be found.

pub fn remove_pattern<const N: usize>(
    &mut self,
    pattern: [Option<Atom>; N],
    match_pattern_length: bool
)

Removes any phrases matching the provided pattern.

If match_pattern_length is true, only phrases matching the exact length of the provided pattern will be removed. Otherwise, phrases longer than the provided pattern may be removed, if their beginning subset matches the pattern.

pub fn push(&mut self, phrase: Vec<Token>) -> PhraseId

Adds a new phrase to the State and returns a PhraseId referencing the newly added phrase.

pub fn len(&self) -> usize

Returns the number of phrases in the State.

pub fn iter(&self) -> impl Iterator<Item = PhraseId> + '_

Returns an iterator of references to phrases in the State.

pub fn get(&self, id: PhraseId) -> &Phrase

Returns the Phrase referenced by the provided PhraseId.

pub fn get_all(&self) -> Vec<Vec<Token>>

Constructs and returns a Vec of all phrases in the State.

pub fn iter_pattern<const N: usize>(
    &self,
    pattern: [Option<Atom>; N],
    match_pattern_length: bool
) -> impl Iterator<Item = PhraseId> + '_

Returns an iterator of references to phrases matching the provided pattern.

If match_pattern_length is true, only phrases matching the exact length of the provided pattern will be returned. Otherwise, phrases longer than the provided pattern may be returned, if their beginning subset matches the pattern.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Display for State

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

Formats the value using the given formatter.

impl Index<usize> for State

type Output = [Token]

The returned type after indexing.

fn index(&self, i: usize) -> &Phrase

Performs the indexing (container[index]) operation.