Struct tiny_actor::Address

source · [−]

pub struct Address<T> { /* private fields */ }

Implementations

source

impl<T> Address<T>

source

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

Attempt to send a message into the channel:

unbounded -> Fails if BackPressure gives a timeout or if the channel is closed.
bounded -> Fails if the channel is closed or full.

source

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

Attempt to send a message into the channel:

unbounded -> Fails if the channel is closed.
bounded -> Fails if the channel is closed or full.

source

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

Attempt to send a message into the channel.

unbounded -> Fails if the channel is closed. If BackPressure gives a timeout, it waits until this timeout is finished.
bounded -> Fails if the channel is closed. If the channel is full, this waits until space is available.

source

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

Same as Address::send except for blocking the current os-thread.

source

pub fn close(&self) -> bool

Close the channel.

source

pub fn halt_all(&self)

Halt all inboxes linked to the channel.

source

pub fn halt_some(&self, n: u32)

Halt n inboxes linked to the channel.

source

pub fn inbox_count(&self) -> usize

Get the amount of inboxes linked to the channel.

source

pub fn msg_count(&self) -> usize

Get the amount of messages linked to the channel.

source

pub fn address_count(&self) -> usize

Get the amount of addresses linked to the channel.

source

pub fn is_closed(&self) -> bool

Whether the channel has been closed.

source

pub fn has_exited(&self) -> bool

Whether all inboxes linked to this channel have exited.

source

pub fn capacity(&self) -> &Capacity

Get the capacity of the channel.

Trait Implementations

source

impl<A> Clone for Address<A>

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<A> Drop for Address<A>

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl<T> Future for Address<T>

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<T> Unpin for Address<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Address<T>

impl<T> Send for Address<T> where
T: Send,

impl<T> Sync for Address<T> where
T: Send,

impl<T> UnwindSafe for Address<T>

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::Address

Implementations

impl<T> Address<T>

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

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

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

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

pub fn close(&self) -> bool

pub fn halt_all(&self)

pub fn halt_some(&self, n: u32)

pub fn inbox_count(&self) -> usize

pub fn msg_count(&self) -> usize

pub fn address_count(&self) -> usize

pub fn is_closed(&self) -> bool

pub fn has_exited(&self) -> bool

pub fn capacity(&self) -> &Capacity

Trait Implementations

impl<A> Clone for Address<A>

fn clone(&self) -> Self

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

impl<A> Drop for Address<A>

fn drop(&mut self)

impl<T> Future for Address<T>

type Output = ()

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

impl<T> Unpin for Address<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Address<T>

impl<T> Send for Address<T> where T: Send,

impl<T> Sync for Address<T> where T: Send,

impl<T> UnwindSafe for Address<T>

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

type Error = <U as TryFrom<T>>::Error

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

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

impl<T> Send for Address<T> where
T: Send,

impl<T> Sync for Address<T> where
T: Send,

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>,