Skip to main content

ActorContext

Struct ActorContext 

Source
pub struct ActorContext<A: ActorCore> { /* private fields */ }
Expand description

actor 的后台端。

由 ActorCore::channel 创建,交给 run 持有。用于接收命令、更新状态/进度、广播事件。

§同步 API

这里的写入方法(update_state、 update_progress、 send_event)和 check_cmd 都是同步的,不需要 runtime;只有 wait_for_cmd 返回 future。

§收命令

  • check_cmd:非阻塞 try_recv,适合“每轮循环顺带看一眼“;
  • wait_for_cmd:recv().await,适合异步壳;
  • recv_cmd_timeout / recv_cmd:阻塞版本,只在 ThreadActor 的上下文里才有(见 thread_actor 模块)。

命令通道关闭(所有 ActorHandle 都 drop 了)后两者分别返回 None, 实现者据此退出循环即可。

Implementations§

Source§

impl<A: ActorCore> ActorContext<A>

Source

pub fn get_events_clone(&self) -> Sender<A::Event>

获取额外的事件发送端。

用于把事件发送端交给别的线程/任务(比如 IO 回调里直接发事件出队列)。

Source

pub fn send_event(&self, event: A::Event)

发送事件(同步,永不失败;没有订阅者时事件被丢弃)。

Source

pub fn update_state(&self, state: A::State)

更新状态。

watch 语义:读者只会看到最新值,中间值可能被跳过。 状态应是低频、可幂等覆盖的数据;高频数据用 update_progress。

Source

pub fn update_progress(&self, progress: A::Progress)

更新进度。

watch 语义:读者只会看到最新值,中间值可能被跳过 —— 对进度条是优点, 但不要拿它当消息队列(每一帧都要的话走事件)。

Source

pub fn wait_for_cmd(&mut self) -> impl Future<Output = Option<A::Cmd>>

等待下一条命令(async)。

命令通道关闭时返回 None,可据此结束 run。

Source

pub fn check_cmd(&mut self) -> Option<A::Cmd>

非阻塞检查命令。

立即返回:有命令就 Some,没有或通道已关闭都是 None。

Source

pub fn cancel_clone(&self) -> CancelToken

获取取消信号,用于在自己循环里检查/等待停止。

异步壳一般写 select! { _ = cancel.cancelled() => break, ... }。

Source

pub fn is_cancelled(&self) -> bool

actor 是否已被要求停止。

Source§

impl<A: ThreadActor> ActorContext<A>

Source

pub fn recv_cmd_timeout(&mut self, dur: Duration) -> Result<A::Cmd, CmdWait>

阻塞等待下一条命令,最多等 dur。会把当前线程 park 住。

有命令 → Ok(cmd);dur 内无命令 → Err(CmdWait::Timeout); 已停止/通道关闭 → Err(CmdWait::Closed)。会被 send_cmd / stop 提前唤醒。 传 Duration::MAX 等价于无限等待。

Source

pub fn recv_cmd(&mut self) -> Option<A::Cmd>

一直阻塞到有命令、或 actor 被停止。

Auto Trait Implementations§

§

impl<A> Forget for ActorContext<A>

§

impl<A> Freeze for ActorContext<A>

§

impl<A> Move for ActorContext<A>

§

impl<A> RefUnwindSafe for ActorContext<A>

§

impl<A> Send for ActorContext<A>

§

impl<A> Sync for ActorContext<A>

§

impl<A> Unpin for ActorContext<A>

§

impl<A> UnsafeUnpin for ActorContext<A>

§

impl<A> UnwindSafe for ActorContext<A>

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more