Struct tiny_actor::actor::Address

source · [−]

pub struct Address<C = dyn AnyChannel> where
    C: DynChannel + ?Sized, { /* private fields */ }

Expand description

An address is a reference to the actor, used to send messages.

Addresses can be of two forms:

Address<Channel<M>>: This is the default form, which can be used to send messages of type M. It can be transformed into an Address using Address::into_dyn.
Address: This form is a dynamic address, which can do everything a normal address can do, except for sending messages. It can be transformed back into an Address<Channel<M>> using Address::downcast::.

An address can be awaited which returns once the actor exits.

Implementations

source

impl<C> Address<C> where
C: DynChannel + ?Sized,

source

pub fn downcast<M: Send + 'static>(self) -> Result<Address<Channel<M>>, Self> where
C: AnyChannel,

Attempt to the downcast the Address into an Address<Channel<M>>.

source

pub fn close(&self) -> bool

Close the Channel.

source

pub fn halt(&self)

Halt the actor.

source

pub fn halt_some(&self, n: u32)

Halt n processes.

source

pub fn process_count(&self) -> usize

Get the amount of processes.

source

pub fn msg_count(&self) -> usize

Get the amount of messages in the Channel.

source

pub fn address_count(&self) -> usize

Get the amount of Addresses of the Channel.

source

pub fn is_closed(&self) -> bool

Whether the Channel is closed.

source

pub fn is_bounded(&self) -> bool

source

pub fn capacity(&self) -> &Capacity

Get the Capacity of the Channel.

source

pub fn has_exited(&self) -> bool

Whether all processes have exited.

source

pub fn actor_id(&self) -> u64

Get the actor’s id.

source

impl<M> Address<Channel<M>>

source

pub fn into_dyn(self) -> AddressⓘNotable traits for Address<C>`impl<C: DynChannel + ?Sized> Future for Address<C> type Output = ();` where
M: Send + 'static,

Convert the Address<Channel<M>> into an Address.

source

pub fn try_send(&self, msg: M) -> Result<(), TrySendError<M>>

Attempt to send a message to the actor.

In the case of an unbounded Channel, when BackPressure returns a timeout this fails.
In the case of a bounded Channel, when it is full this fails.

For bounded channels, this method is the same as send_now.

source

pub fn send_now(&self, msg: M) -> Result<(), TrySendError<M>>

Attempt to send a message to the actor.

In the case of an unbounded Channel, any BackPressure is ignored.
In the case of a bounded Channel, when it is full this fails.

For bounded channels, this method is the same as try_send.

source

pub fn send(&self, msg: M) -> Snd<'_, M>ⓘNotable traits for Snd<'a, M>`impl<'a, M> Future for Snd<'a, M> type Output = Result<(), SendError<M>>;`

Attempt to send a message to the actor.

In the case of an unbounded Channel, when BackPressure returns a timeout this waits untill the timeout is over.
In the case of a bounded Channel, when it is full this waits untill space is available.

source

pub fn send_blocking(&self, msg: M) -> Result<(), SendError<M>>

Same as send but it blocking the OS-thread.

Trait Implementations

source

impl<C: DynChannel + ?Sized> Clone for Address<C>

source

fn clone(&self) -> Self

Returns a copy 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<C: Debug> Debug for Address<C> where
C: DynChannel + ?Sized,

source

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

Formats the value using the given formatter. Read more

source

impl<C: DynChannel + ?Sized> Drop for Address<C>

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl<C: DynChannel + ?Sized> Future for Address<C>

type Output = ()

The type of value produced on completion.

source

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

source

impl<C: DynChannel + ?Sized> Unpin for Address<C>

Auto Trait Implementations

impl<C: ?Sized> RefUnwindSafe for Address<C> where
C: RefUnwindSafe,

impl<C: ?Sized> Send for Address<C> where
C: Send + Sync,

impl<C: ?Sized> Sync for Address<C> where
C: Send + Sync,

impl<C: ?Sized> UnwindSafe for Address<C> where
C: RefUnwindSafe,

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T where
T: Future + ?Sized,

fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

fn map_into(self) -> MapInto<Self, U> where
Self::Output: Into,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

fn left_future(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more

fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream. Read more

fn flatten(self) -> Flatten<Self> where
Self::Output: Future,

Flatten the execution of this future when the output of this future is itself another future. Read more

fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,

Flatten the execution of this future when the successful result of this future is a stream. Read more

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),

Do something with the output of a future before passing it on. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

Catches unwinding panics while polling the future. Read more

fn shared(self) -> Shared<Self> where
Self::Output: Clone,

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)

Turn this future into a future that yields () on completion and sends its output to another future on a separate task. Read more

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

Wrap the future in a Box, pinning it. Read more

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,

Wrap the future in a Box, pinning it. Read more

fn unit_error(self) -> UnitError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = ()>. Read more

fn never_error(self) -> NeverError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = Never>. Read more

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

A convenience for calling Future::poll on Unpin future types.

fn now_or_never(self) -> Option<Self::Output>

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to Future::poll. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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<F> IntoFuture for F where
F: Future,

type Output = <F as Future>::Output

The output that the future will produce on completion.

type IntoFuture = F

Which kind of future are we turning this into?

source

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more

source

impl<T> ToOwned for T where
T: Clone,

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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct tiny_actor::actor::Address

Implementations

impl<C> Address<C> where C: DynChannel + ?Sized,

pub fn downcast<M: Send + 'static>(self) -> Result<Address<Channel<M>>, Self> where C: AnyChannel,

pub fn close(&self) -> bool

pub fn halt(&self)

pub fn halt_some(&self, n: u32)

pub fn process_count(&self) -> usize

pub fn msg_count(&self) -> usize

pub fn address_count(&self) -> usize

pub fn is_closed(&self) -> bool

pub fn is_bounded(&self) -> bool

pub fn capacity(&self) -> &Capacity

pub fn has_exited(&self) -> bool

pub fn actor_id(&self) -> u64

impl<M> Address<Channel<M>>

pub fn into_dyn(self) -> AddressⓘNotable traits for Address<C>impl<C: DynChannel + ?Sized> Future for Address<C> type Output = (); where M: Send + 'static,

pub fn try_send(&self, msg: M) -> Result<(), TrySendError<M>>

pub fn send_now(&self, msg: M) -> Result<(), TrySendError<M>>

pub fn send(&self, msg: M) -> Snd<'_, M>ⓘNotable traits for Snd<'a, M>impl<'a, M> Future for Snd<'a, M> type Output = Result<(), SendError<M>>;

pub fn send_blocking(&self, msg: M) -> Result<(), SendError<M>>

Trait Implementations

impl<C: DynChannel + ?Sized> Clone for Address<C>

fn clone(&self) -> Self

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

impl<C: Debug> Debug for Address<C> where C: DynChannel + ?Sized,

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

impl<C: DynChannel + ?Sized> Drop for Address<C>

fn drop(&mut self)

impl<C: DynChannel + ?Sized> Future for Address<C>

type Output = ()

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

impl<C: DynChannel + ?Sized> Unpin for Address<C>

Auto Trait Implementations

impl<C: ?Sized> RefUnwindSafe for Address<C> where C: RefUnwindSafe,

impl<C: ?Sized> Send for Address<C> where C: Send + Sync,

impl<C: ?Sized> Sync for Address<C> where C: Send + Sync,

impl<C: ?Sized> UnwindSafe for Address<C> where C: RefUnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T where T: Future + ?Sized,

fn map<U, F>(self, f: F) -> Map<Self, F> where F: FnOnce(Self::Output) -> U,

fn map_into<U>(self) -> MapInto<Self, U> where Self::Output: Into<U>,

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where F: FnOnce(Self::Output) -> Fut, Fut: Future,

fn left_future<B>(self) -> Either<Self, B> where B: Future<Output = Self::Output>,

fn right_future<A>(self) -> Either<A, Self> where A: Future<Output = Self::Output>,

fn into_stream(self) -> IntoStream<Self>

fn flatten(self) -> Flatten<Self> where Self::Output: Future,

fn flatten_stream(self) -> FlattenStream<Self> where Self::Output: Stream,

fn fuse(self) -> Fuse<Self>

fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnOnce(&Self::Output),

fn catch_unwind(self) -> CatchUnwind<Self> where Self: UnwindSafe,

fn shared(self) -> Shared<Self> where Self::Output: Clone,

fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)

fn boxed<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where Self: 'a + Send,

fn boxed_local<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where Self: 'a,

fn unit_error(self) -> UnitError<Self>

fn never_error(self) -> NeverError<Self>

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin,

fn now_or_never(self) -> Option<Self::Output>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<F> IntoFuture for F where F: Future,

type Output = <F as Future>::Output

type IntoFuture = F

fn into_future(self) -> <F as IntoFuture>::IntoFuture

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<C> Address<C> where
C: DynChannel + ?Sized,

pub fn downcast<M: Send + 'static>(self) -> Result<Address<Channel<M>>, Self> where
C: AnyChannel,

pub fn into_dyn(self) -> AddressⓘNotable traits for Address<C>`impl<C: DynChannel + ?Sized> Future for Address<C> type Output = ();` where
M: Send + 'static,

pub fn send(&self, msg: M) -> Snd<'_, M>ⓘNotable traits for Snd<'a, M>`impl<'a, M> Future for Snd<'a, M> type Output = Result<(), SendError<M>>;`

impl<C: Debug> Debug for Address<C> where
C: DynChannel + ?Sized,

impl<C: ?Sized> RefUnwindSafe for Address<C> where
C: RefUnwindSafe,

impl<C: ?Sized> Send for Address<C> where
C: Send + Sync,

impl<C: ?Sized> Sync for Address<C> where
C: Send + Sync,

impl<C: ?Sized> UnwindSafe for Address<C> where
C: RefUnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

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

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

impl<T> FutureExt for T where
T: Future + ?Sized,

fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,

fn map_into<U>(self) -> MapInto<Self, U> where
Self::Output: Into<U>,

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,

fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,

fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,

fn flatten(self) -> Flatten<Self> where
Self::Output: Future,

fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

fn shared(self) -> Shared<Self> where
Self::Output: Clone,

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

impl<T, U> Into<U> for T where
U: From<T>,

impl<F> IntoFuture for F where
F: Future,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,