Struct xtra::sink::AddressSink

source · [−]

pub struct AddressSink<A: Actor, Rc: RefCounter = Strong> { /* private fields */ }

Expand description

An AddressSink is the futures Sink returned by Address::into_sink. Similarly to with addresses, the strong variety of AddressSink will prevent the actor from being dropped, whereas the weak variety will not.

Implementations

source

impl<A: Actor, Rc: RefCounter> AddressSink<A, Rc>

source

pub fn is_connected(&self) -> bool

Returns whether the actor referred to by this address sink is running and accepting messages.

source

impl<A: Actor> AddressSink<A, Strong>

source

pub fn downgrade(&self) -> WeakAddressSink<A>

Create a weak address sink. Unlike with the strong variety of address sink (this kind), an actor will not be prevented from being dropped if only weak sinks, channels, and addresses exist.

Trait Implementations

source

impl<A: Actor, Rc: RefCounter> Clone for AddressSink<A, Rc>

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: Actor, Rc: RefCounter> Drop for AddressSink<A, Rc>

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl<A: Actor, M: Message, Rc: RefCounter> MessageSink<M> for AddressSink<A, Rc> where
A: Handler<M>,

source

fn is_connected(&self) -> bool

Returns whether the actor referred to by this message sink is running and accepting messages.

source

fn clone_message_sink(&self) -> Box<dyn MessageSink<M>>

Clones this message sink as a boxed trait object.

source

impl<A: Actor, Rc: RefCounter, M: Message> Sink<M> for AddressSink<A, Rc> where
A: Handler<M>,

type Error = Disconnected

The type of value produced by the sink when an error occurs.

source

fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value. Read more

source

fn start_send(self: Pin<&mut Self>, item: M) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())). Read more

source

fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink. Read more

source

fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary. Read more

source

impl<A: Actor, M: Message> StrongMessageSink<M> for AddressSink<A, Strong> where
A: Handler<M>,

source

fn downgrade(self) -> Box<dyn WeakMessageSink<M>>

Create a weak message sink. Unlike with the strong variety of message sink (this kind), an actor will not be prevented from being dropped if only weak sinks, channels, and addresses exist. Read more

source

fn upcast(self) -> Box<dyn MessageSink<M, Error = Disconnected>>

Upcasts this strong message sink into a boxed generic MessageSink trait object Read more

source

fn upcast_ref(&self) -> &dyn MessageSink<M, Error = Disconnected>

Upcasts this strong message sink into a reference to the generic MessageSink trait object Read more

source

fn clone_message_sink(&self) -> Box<dyn StrongMessageSink<M>>

Clones this message sink as a boxed trait object.

source

impl<A: Actor, M: Message> WeakMessageSink<M> for AddressSink<A, Weak> where
A: Handler<M>,

source

fn upcast(self) -> Box<dyn MessageSink<M, Error = Disconnected>>

Upcasts this weak message sink into a boxed generic MessageSink trait object Read more

source

fn upcast_ref(&self) -> &dyn MessageSink<M, Error = Disconnected>

Upcasts this weak message sink into a reference to the generic MessageSink trait object Read more

source

fn clone_message_sink(&self) -> Box<dyn WeakMessageSink<M>>

Clones this message sink as a boxed trait object.

Auto Trait Implementations

impl<A, Rc = Strong> !RefUnwindSafe for AddressSink<A, Rc>

impl<A, Rc> Send for AddressSink<A, Rc>

impl<A, Rc = Strong> !Sync for AddressSink<A, Rc>

impl<A, Rc> Unpin for AddressSink<A, Rc>

impl<A, Rc = Strong> !UnwindSafe for AddressSink<A, Rc>

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.

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<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,

source

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
 F: FnMut(U) -> Fut,
 Fut: Future<Output = Result<Item, E>>,
 E: From<Self::Error>,

Composes a function in front of the sink. Read more

source

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,

Composes a function in front of the sink. Read more

source

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,

Transforms the error returned by the sink.

source

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,

Map this sink’s error to a different error type using the Into trait. Read more

source

fn buffer(self, capacity: usize) -> Buffer<Self, Item>

Adds a fixed-size buffer to the current sink. Read more

source

fn close(&mut self) -> Close<'_, Self, Item> where
Self: Unpin,

Close the sink.

source

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,

Fanout items to multiple sinks. Read more

source

fn flush(&mut self) -> Flush<'_, Self, Item> where
Self: Unpin,

Flush the sink, processing all pending items. Read more

source

fn send(&mut self, item: Item) -> Send<'_, Self, Item> where
Self: Unpin,

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

source

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item> where
Self: Unpin,

A future that completes after the given item has been received by the sink. Read more

source

fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
Self: Unpin,

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

source

fn left_sink<Si2>(self) -> Either<Self, Si2> where
Si2: Sink<Item, Error = Self::Error>,

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

source

fn right_sink<Si1>(self) -> Either<Si1, Self> where
Si1: Sink<Item, Error = Self::Error>,

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

source

fn poll_ready_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
 Self: Unpin,

A convenience method for calling Sink::poll_ready on Unpin sink types. Read more

source

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,

A convenience method for calling Sink::start_send on Unpin sink types. Read more

source

fn poll_flush_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
 Self: Unpin,

A convenience method for calling Sink::poll_flush on Unpin sink types. Read more

source

fn poll_close_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
 Self: Unpin,

A convenience method for calling Sink::poll_close on Unpin sink types. 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 xtra::sink::AddressSink

Implementations

impl<A: Actor, Rc: RefCounter> AddressSink<A, Rc>

pub fn is_connected(&self) -> bool

impl<A: Actor> AddressSink<A, Strong>

pub fn downgrade(&self) -> WeakAddressSink<A>

Trait Implementations

impl<A: Actor, Rc: RefCounter> Clone for AddressSink<A, Rc>

fn clone(&self) -> Self

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

impl<A: Actor, Rc: RefCounter> Drop for AddressSink<A, Rc>

fn drop(&mut self)

impl<A: Actor, M: Message, Rc: RefCounter> MessageSink<M> for AddressSink<A, Rc> where A: Handler<M>,

fn is_connected(&self) -> bool

fn clone_message_sink(&self) -> Box<dyn MessageSink<M>>

impl<A: Actor, Rc: RefCounter, M: Message> Sink<M> for AddressSink<A, Rc> where A: Handler<M>,

type Error = Disconnected

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

fn start_send(self: Pin<&mut Self>, item: M) -> Result<(), Self::Error>

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

impl<A: Actor, M: Message> StrongMessageSink<M> for AddressSink<A, Strong> where A: Handler<M>,

fn downgrade(self) -> Box<dyn WeakMessageSink<M>>

fn upcast(self) -> Box<dyn MessageSink<M, Error = Disconnected>>

fn upcast_ref(&self) -> &dyn MessageSink<M, Error = Disconnected>

fn clone_message_sink(&self) -> Box<dyn StrongMessageSink<M>>

impl<A: Actor, M: Message> WeakMessageSink<M> for AddressSink<A, Weak> where A: Handler<M>,

fn upcast(self) -> Box<dyn MessageSink<M, Error = Disconnected>>

fn upcast_ref(&self) -> &dyn MessageSink<M, Error = Disconnected>

fn clone_message_sink(&self) -> Box<dyn WeakMessageSink<M>>

Auto Trait Implementations

impl<A, Rc = Strong> !RefUnwindSafe for AddressSink<A, Rc>

impl<A, Rc> Send for AddressSink<A, Rc>

impl<A, Rc = Strong> !Sync for AddressSink<A, Rc>

impl<A, Rc> Unpin for AddressSink<A, Rc>

impl<A, Rc = Strong> !UnwindSafe for AddressSink<A, Rc>

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

fn into(self) -> U

impl<T, Item> SinkExt<Item> for T where T: Sink<Item> + ?Sized,

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where F: FnMut(U) -> Fut, Fut: Future<Output = Result<Item, E>>, E: From<Self::Error>,

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where F: FnMut(U) -> St, St: Stream<Item = Result<Item, Self::Error>>,

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where F: FnOnce(Self::Error) -> E,

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self::Error: Into<E>,

fn buffer(self, capacity: usize) -> Buffer<Self, Item>

fn close(&mut self) -> Close<'_, Self, Item> where Self: Unpin,

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where Item: Clone, Si: Sink<Item, Error = Self::Error>,

fn flush(&mut self) -> Flush<'_, Self, Item> where Self: Unpin,

fn send(&mut self, item: Item) -> Send<'_, Self, Item> where Self: Unpin,

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item> where Self: Unpin,

fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized, Self: Unpin,

fn left_sink<Si2>(self) -> Either<Self, Si2> where Si2: Sink<Item, Error = Self::Error>,

fn right_sink<Si1>(self) -> Either<Si1, Self> where Si1: Sink<Item, Error = Self::Error>,

fn poll_ready_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> where Self: Unpin,

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where Self: Unpin,

fn poll_flush_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> where Self: Unpin,

fn poll_close_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> where Self: Unpin,

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>

impl<A: Actor, M: Message, Rc: RefCounter> MessageSink<M> for AddressSink<A, Rc> where
A: Handler<M>,

impl<A: Actor, Rc: RefCounter, M: Message> Sink<M> for AddressSink<A, Rc> where
A: Handler<M>,

fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

impl<A: Actor, M: Message> StrongMessageSink<M> for AddressSink<A, Strong> where
A: Handler<M>,

impl<A: Actor, M: Message> WeakMessageSink<M> for AddressSink<A, Weak> where
A: Handler<M>,

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

impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
E: From<Self::Error>,

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,

fn close(&mut self) -> Close<'_, Self, Item> where
Self: Unpin,

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,

fn flush(&mut self) -> Flush<'_, Self, Item> where
Self: Unpin,

fn send(&mut self, item: Item) -> Send<'_, Self, Item> where
Self: Unpin,

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item> where
Self: Unpin,

fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
Self: Unpin,

fn left_sink<Si2>(self) -> Either<Self, Si2> where
Si2: Sink<Item, Error = Self::Error>,

fn right_sink<Si1>(self) -> Either<Si1, Self> where
Si1: Sink<Item, Error = Self::Error>,

fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,

fn poll_flush_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,

fn poll_close_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,

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