State

Struct State 

Source
pub struct State { /* private fields */ }
Expand description

Stores a set of Phrases.

Implementations§

Source§

impl State

Source

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

Removes a phrase by PhraseId.

Source

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.

Source

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.

Source

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.

Source

pub fn len(&self) -> usize

Returns the number of phrases in the State.

Source

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

Returns an iterator of references to phrases in the State.

Source

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

Returns the Phrase referenced by the provided PhraseId.

Source

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

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

Source

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§

Source§

impl Clone for State

Source§

fn clone(&self) -> State

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for State

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for State

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Index<usize> for State

Source§

type Output = [Token]

The returned type after indexing.
Source§

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

Performs the indexing (container[index]) operation. Read more

Auto Trait Implementations§

§

impl Freeze for State

§

impl RefUnwindSafe for State

§

impl Send for State

§

impl Sync for State

§

impl Unpin for State

§

impl UnwindSafe for State

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V