Skip to main content

Endpoint

Struct Endpoint 

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

The primary handle for interacting with an actor.

Endpoint<A> is generic over actor type A, providing compile-time guarantees that the actor can handle the message being sent. Endpoints are cheap to clone and can be shared across tasks.

Under the hood, an endpoint is either local (in-memory channel) or remote (serializes over QUIC). The caller never knows which — the API is identical.

§Examples

// Obtain from system.start() or system.lookup()
let counter = system.start("counter/0", Counter, CounterState { count: 0 });

// Send a sync message
let count = counter.send(Increment { amount: 5 }).await?;

// Send an async message
let data = counter.send_async(FetchData { key: "x".into() }).await?;

// Clone and share across tasks
let counter2 = counter.clone();
tokio::spawn(async move {
    counter2.send(Increment { amount: 1 }).await.ok();
});

Implementations§

Source§

impl<A: Actor + 'static> Endpoint<A>

Source

pub async fn send<M>(&self, message: M) -> Result<M::Result, SendError>

Send a message to the actor. Identical API for local and remote.

Compile-time checked:

  • A must implement Handler<M>
  • M must implement RemoteMessage (serializable)

For local actors: uses the envelope pattern (zero serialization cost). For remote actors: serializes, sends over wire, awaits response.

§Examples
let count = counter.send(Increment { amount: 5 }).await?;

// Error handling
match counter.send(Increment { amount: 1 }).await {
    Ok(new_count) => println!("Count: {new_count}"),
    Err(SendError::MailboxClosed) => println!("Actor stopped"),
    Err(e) => println!("Send failed: {e}"),
}
Source

pub async fn send_async<M>(&self, message: M) -> Result<M::Result, SendError>

Send a message to an async handler. Identical API for local and remote.

Like send but dispatches through AsyncHandler<M> so the handler can .await inside its body.

§Examples
// For actors that implement AsyncHandler<FetchData>
let data = endpoint.send_async(FetchData { key: "users".into() }).await?;

Trait Implementations§

Source§

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

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

Auto Trait Implementations§

§

impl<A> Freeze for Endpoint<A>

§

impl<A> RefUnwindSafe for Endpoint<A>

§

impl<A> Send for Endpoint<A>

§

impl<A> Sync for Endpoint<A>

§

impl<A> Unpin for Endpoint<A>

§

impl<A> UnsafeUnpin for Endpoint<A>

§

impl<A> UnwindSafe for Endpoint<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 = 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.
Source§

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

Source§

fn vzip(self) -> V

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