Skip to main content

ActorHandle

Struct ActorHandle 

Source
pub struct ActorHandle<A: Actor> { /* private fields */ }
Expand description

actor 的控制端。

由 Actor::channel 创建,通常由外部控制方持有。 用于发送命令、读取状态/进度、订阅事件,以及注册异步监听。

§示例

let (context, handle) = MyActor::channel( (), ());

handle.send_cmd(()).await.unwrap();
let state = handle.get_state();

let listener = handle.state_listen_async(|s| async move { });
listener.cancel();

Implementations§

Source§

impl<A: Actor> ActorHandle<A>

Source

pub async fn send_cmd(&self, cmd: A::Cmd) -> Result<(), SendError<A::Cmd>>

向 actor 发送一条命令。

Source

pub fn get_state(&self) -> A::State

获取 actor 的最新状态。

Source

pub fn state_listen_async<F, Fut>(&self, op: F) -> CancelToken
where F: FnMut(A::State) -> Fut + Send + 'static, Fut: Future<Output = ()> + Send,

异步监听状态变化。

每次状态变化时会调用 op,传入最新状态。 op 返回 true 继续监听,返回 false 停止。

返回的 [ListenerHandle] 被 drop 或调用 cancel() 时停止监听。

Source

pub fn get_progress(&self) -> A::Progress

获取 actor 的最新进度。

Source

pub fn progress_listen_async<F, Fut>(&self, op: F) -> CancelToken
where F: FnMut(A::Progress) -> Fut + Send + 'static, Fut: Future<Output = ()> + Send,

Source

pub fn get_events_rx(&self) -> Receiver<A::Event>

Source

pub fn events_listen_async<F, Fut>(&self, op: F) -> CancelToken
where F: FnMut(A::Event) -> Fut + Send + 'static, Fut: Future<Output = ()> + Send,

Source

pub fn stop(&self)

Trait Implementations§

Source§

impl<A: Actor> Clone for ActorHandle<A>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<A> Freeze for ActorHandle<A>
where Sender<<A as Actor>::Cmd>: Freeze, Receiver<<A as Actor>::State>: Freeze, Sender<<A as Actor>::Event>: Freeze, Receiver<<A as Actor>::Progress>: Freeze,

§

impl<A> RefUnwindSafe for ActorHandle<A>

§

impl<A> Send for ActorHandle<A>
where Sender<<A as Actor>::Cmd>: Send, Receiver<<A as Actor>::State>: Send, Sender<<A as Actor>::Event>: Send, Receiver<<A as Actor>::Progress>: Send,

§

impl<A> Sync for ActorHandle<A>
where Sender<<A as Actor>::Cmd>: Sync, Receiver<<A as Actor>::State>: Sync, Sender<<A as Actor>::Event>: Sync, Receiver<<A as Actor>::Progress>: Sync,

§

impl<A> Unpin for ActorHandle<A>
where Sender<<A as Actor>::Cmd>: Unpin, Receiver<<A as Actor>::State>: Unpin, Sender<<A as Actor>::Event>: Unpin, Receiver<<A as Actor>::Progress>: Unpin,

§

impl<A> UnsafeUnpin for ActorHandle<A>

§

impl<A> UnwindSafe for ActorHandle<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> 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> 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> 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 = !

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