Skip to main content

StateContext

Struct StateContext 

Source
pub struct StateContext {
    pub current_state: String,
    /* private fields */
}
Expand description

The FSM context injected into state-matched handlers.

Provides typed access to state transitions and arbitrary key-value data associated with the current conversation slot.

Fields§

§current_state: String

The state key that matched this handler, provided as context.

Implementations§

Source§

impl StateContext

Source

pub fn new( storage: Arc<dyn StateStorage>, key: StateKey, current_state: String, ) -> Self

Construct a new StateContext. Called internally by the dispatcher.

Source

pub async fn transition( &self, new_state: impl FsmState, ) -> Result<(), StorageError>

Transition to a new state. Overwrites the current state.

Source

pub async fn clear_state(&self) -> Result<(), StorageError>

Clear the current state (set to None). Leaves data intact.

Source

pub async fn set_data<T: Serialize>( &self, field: &str, value: T, ) -> Result<(), StorageError>

Set a typed data value for field. The value is serialized to JSON.

Source

pub async fn get_data<T: DeserializeOwned>( &self, field: &str, ) -> Result<Option<T>, StorageError>

Get a typed data value for field. Returns None if not set.

Source

pub async fn get_all_data(&self) -> Result<HashMap<String, Value>, StorageError>

Return all data fields as a raw JSON map.

Source

pub async fn clear_data(&self) -> Result<(), StorageError>

Remove all data fields. State is unchanged.

Source

pub async fn clear_all(&self) -> Result<(), StorageError>

Reset both state and all data (full conversation reset).

Source

pub fn key(&self) -> &StateKey

The StateKey for this conversation slot.

Trait Implementations§

Source§

impl Clone for StateContext

Source§

fn clone(&self) -> StateContext

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 StateContext

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, 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.