Struct telers::fsm::context::Context

pub struct Context<S> { /* private fields */ }

Context is used to manage state and data of the user in specified storage

Implementations

impl<S> Context<S>

pub fn new(storage: S, key: StorageKey) -> Self

impl<S> Context<S>

where S: Storage,

pub async fn set_state<State>(&self, state: State) -> Result<(), S::Error>

where State: Into<Cow<'static, str>> + Send,

Set current state

Arguments

• state - State

Errors

If storage error occurs, when set state

pub async fn set_previous_state(&self) -> Result<(), S::Error>

Set previous state as current state

Errors

If storage error occurs, when set previous state

Notes

States stack is used to store states history, when user set new state, then current state will be push to the states stack, so you can use this method to back to the previous state

pub async fn get_state(&self) -> Result<Option<Box<str>>, S::Error>

Get current state

Errors

If storage error occurs, when get state

Returns

State, if state is no exists, then None will be return

pub async fn get_states(&self) -> Result<Box<[Box<str>]>, S::Error>

Get states stack

Errors

If storage error occurs, when get states stack

Notes

States stack is used to store states history, when user set new state, then current state will be push to the states stack, so you can use this method to get states history or back to the previous state

Returns

States, if states is no exists, then empty slice will be return

pub async fn remove_states(&self) -> Result<(), S::Error>

Remove states stack

Errors

If storage error occurs, when remove states stack

Notes

States stack is used to store states history, when user set new state, then current state will be push to the states stack, so you can use this method to clear states history

pub async fn set_data<Key, Data>( &self, data: HashMap<Key, Data>, ) -> Result<(), S::Error>

where Data: Serialize + Send, Key: Serialize + Into<Cow<'static, str>> + Send,

Set current data

Arguments

• data - Data, if empty, then data will be clear

Errors

If storage error occurs, when set data

pub async fn set_value<Key, Value>( &self, value_key: Key, value: Value, ) -> Result<(), S::Error>

where Value: Serialize + Send, Key: Serialize + Into<Cow<'static, str>> + Send,

Set value to the data for value key

Arguments

• value_key - Specified value key to set value to data
• value - Value for value key

Errors

If storage error occurs, when set value to data

pub async fn get_data<Data>(&self) -> Result<HashMap<Box<str>, Data>, S::Error>

where Data: DeserializeOwned,

Get current data

Errors

If storage error occurs, when get data

Returns

Data, if data is no exists, then empty HashMap will be return

pub async fn get_value<Key, Value>( &self, value_key: Key, ) -> Result<Option<Value>, S::Error>

where Value: DeserializeOwned, Key: Into<Cow<'static, str>> + Send,

Get value from data for value key

Arguments

• value_key - Specified value key to get value from data

Errors

If storage error occurs, when get value from data

Returns

Value, if value is no exists, then None will be return

pub async fn remove_data(&self) -> Result<(), S::Error>

Remove current data

Errors

If storage error occurs, when remove data

pub async fn finish(&self) -> Result<(), S::Error>

Finish current context by remove state and data. This method is just shortcut for Context::remove_states and Context::remove_data methods

Errors

If storage error occurs, when remove state or data

Trait Implementations

impl<S> Clone for Context<S>

where S: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S, __C> FromEventAndContext<__C> for Context<S>

where Context<S>: Clone + 'static,

type Error = Error

fn extract( bot: Arc<Bot<__C>>, update: Arc<Update>, context: Arc<Context>, ) -> Result<Self, Self::Error>

Extracts data from Update, Context and Bot to handler argument