Struct StateGuard

Source
pub struct StateGuard<S> { /* private fields */ }
Expand description

State 守卫,使用 RAII 模式自动管理 State 的设置和清理

当 StateGuard 被创建时,会自动设置当前线程的 State 上下文 当 StateGuard 被丢弃时(包括异常情况),会自动清理 State 上下文

§示例

use std::sync::Arc;
use mf_state::State;
use mf_rules_expression::functions::StateGuard;

// 创建 State
let state = Arc::new(State::default());

{
    // 设置 State 上下文
    let _guard = StateGuard::new(state);
     
    // 在这个作用域内,自定义函数可以访问 State
    // 即使发生 panic,State 也会被正确清理
     
} // 这里 StateGuard 被自动丢弃,State 上下文被清理

Implementations§

Source§

impl<S: Send + Sync + 'static> StateGuard<S>

Source

pub fn new(state: Arc<S>) -> Self

创建新的 State 守卫

§参数
  • state - 要设置的 State 对象
§返回值

返回 StateGuard 实例,当其被丢弃时会自动清理 State

Source

pub fn empty() -> Self

创建空的 State 守卫(用于清理已有的 State)

§返回值

返回 StateGuard 实例,会立即清理当前 State 并在丢弃时保持清理状态

Source

pub fn has_active_state() -> bool

获取当前是否有活跃的 State

§返回值
  • true - 当前线程有活跃的 State
  • false - 当前线程没有 State

Trait Implementations§

Source§

impl<S> Drop for StateGuard<S>

Source§

fn drop(&mut self)

自动清理 State 上下文

当 StateGuard 被丢弃时(正常情况或异常情况), 会自动清理当前线程的 State 上下文

Auto Trait Implementations§

§

impl<S> Freeze for StateGuard<S>

§

impl<S> RefUnwindSafe for StateGuard<S>
where S: RefUnwindSafe,

§

impl<S> Send for StateGuard<S>
where S: Send,

§

impl<S> Sync for StateGuard<S>
where S: Sync,

§

impl<S> Unpin for StateGuard<S>
where S: Unpin,

§

impl<S> UnwindSafe for StateGuard<S>
where S: UnwindSafe,

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