Context

Struct Context 

Source
#[non_exhaustive]
pub struct Context { pub core: Core, pub string_cache: StringCache, }
Expand description

Stores the State, Rules and Atom mappings for a Throne script.

Create a new Context using a ContextBuilder.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§core: Core§string_cache: StringCache

Implementations§

Source§

impl Context

Source

pub fn update(&mut self) -> Result<(), Error>

Executes any Rule that matches the current State until the set of matching rules is exhausted.

Source

pub fn update_with_side_input<F>(&mut self, side_input: F) -> Result<(), Error>
where F: SideInput,

Equivalent to Context::update(), but accepts a callback to respond to ^ predicates.

Source

pub fn execute_rule(&mut self, rule: &Rule) -> bool

Executes a specific Rule.

Returns true if the Rule was successfully executed or false if some of its inputs could not be matched to the current State.

Source

pub fn find_matching_rules<F>( &self, side_input: F, ) -> Result<Vec<Rule>, ExcessivePermutationError>
where F: SideInput,

Returns the set of Rules that may be executed in the next update.

Source

pub fn str_to_atom(&mut self, text: &str) -> Atom

Source

pub fn str_to_existing_atom(&self, text: &str) -> Option<Atom>

Source

pub fn atom_to_str(&self, atom: Atom) -> Option<&str>

Source

pub fn atom_to_integer(&self, atom: Atom) -> Option<i32>

Source

pub fn push_state(&mut self, phrase_text: &str)

Converts the provided text to a Phrase and adds it to the context’s State.

Source

pub fn extend_state_from_context(&mut self, other: &Context)

Copies the state from another Context to this one.

Source

pub fn print(&self)

Prints a representation of the Context to the console.

Trait Implementations§

Source§

impl Clone for Context

Source§

fn clone(&self) -> Context

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 Display for Context

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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