Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

A scoped caller context.

Dropping the last clone of a client closes its mailbox. Messages already accepted into port receivers remain available; later deliveries to the client’s ports fail as ordinary closed-mailbox deliveries.

Implementations§

Source§

impl Client

Source

pub fn self_addr(&self) -> &ActorAddr

This client’s actor address.

Source

pub fn proc(&self) -> &Proc

The proc that owns this client.

Source

pub fn open_port<M: Message>(&self) -> (PortHandle<M>, PortReceiver<M>)

Open a new port that accepts M-typed messages.

Source

pub fn open_once_port<M: Message>( &self, ) -> (OncePortHandle<M>, OncePortReceiver<M>)

Open a new one-shot port that accepts an M-typed message.

Source

pub fn bind_handler_port<M: RemoteMessage>( &self, ) -> (PortHandle<M>, PortReceiver<M>)

Bind a handler port to this client.

Source

pub fn bind<R: Binds<ClientActor>>(&self) -> ActorRef<R>

Bind this client as an actor ref.

Source

pub fn child(&self) -> Client

Create a new direct child client.

Source

pub fn spawn<A: Actor>(&self, actor: A) -> ActorHandle<A>

Spawn a child actor with a fresh uid labeled from the actor type.

Source

pub fn spawn_with_label<A: Actor>( &self, label: &str, actor: A, ) -> ActorHandle<A>

Spawn a child actor with a fresh uid carrying a display label.

Source

pub fn spawn_with_uid<A: Actor>( &self, uid: Uid, actor: A, ) -> Result<ActorHandle<A>>

Spawn a child actor using an explicit uid.

Source

pub async fn gspawn( &self, actor_type: &str, params: Data, ) -> Result<AnyActorHandle>

Spawn a registered actor as this client’s child.

Source

pub async fn gspawn_uid( &self, actor_type: &str, uid: Uid, params: Data, ) -> Result<AnyActorHandle>

Spawn a registered actor as this client’s child using an explicit uid.

Source

pub fn sequencer(&self) -> &Sequencer

Return this client’s sequencer.

Source

pub fn status(&self) -> Receiver<ActorStatus>

The client’s lifecycle status.

Trait Implementations§

Source§

impl Actor for &Client

Source§

type A = ClientActor

The type of actor associated with this context.
Source§

fn instance(&self) -> &Instance<ClientActor>

The instance associated with this context.
Source§

fn spawn<C: Actor>(&self, actor: C) -> ActorHandle<C>
where Self: Sized,

Spawn a child actor under this actor context.
Source§

fn spawn_with_label<C: Actor>(&self, label: &str, actor: C) -> ActorHandle<C>
where Self: Sized,

Spawn a child actor with a fresh uid carrying a display label.
Source§

fn spawn_with_uid<C: Actor>(&self, uid: Uid, actor: C) -> Result<ActorHandle<C>>
where Self: Sized,

Spawn a child actor using an explicit uid.
Source§

fn headers(&self) -> &Flattrs

The inbound message headers associated with this context, if any. Read more
Source§

impl Actor for Client

Source§

type A = ClientActor

The type of actor associated with this context.
Source§

fn instance(&self) -> &Instance<ClientActor>

The instance associated with this context.
Source§

fn spawn<C: Actor>(&self, actor: C) -> ActorHandle<C>
where Self: Sized,

Spawn a child actor under this actor context.
Source§

fn spawn_with_label<C: Actor>(&self, label: &str, actor: C) -> ActorHandle<C>
where Self: Sized,

Spawn a child actor with a fresh uid carrying a display label.
Source§

fn spawn_with_uid<C: Actor>(&self, uid: Uid, actor: C) -> Result<ActorHandle<C>>
where Self: Sized,

Spawn a child actor using an explicit uid.
Source§

fn headers(&self) -> &Flattrs

The inbound message headers associated with this context, if any. Read more
Source§

impl Clone for Client

Source§

fn clone(&self) -> Self

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 Client

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Mailbox for &Client

Source§

fn mailbox(&self) -> &Mailbox

The mailbox associated with this context
Source§

impl Mailbox for Client

Source§

fn mailbox(&self) -> &Mailbox

The mailbox associated with this context

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.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

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

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

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> QuoteExt for T
where T: ?Sized,

§

fn push_quoted<'q, Q, S>(&mut self, _q: Q, s: S)
where Q: QuoteInto<T>, S: Into<Quotable<'q>>,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<M> Message for M
where M: Send + Sync + 'static,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,