Struct wick_packet::FluxReceiver

pub struct FluxReceiver<Item, Err>where
    Item: ConditionallySafe,
    Err: ConditionallySafe,{ /* private fields */ }

The receving end-only of a crate::Flux

Implementations

impl<Item, Err> FluxReceiver<Item, Err>where Item: ConditionallySafe, Err: ConditionallySafe,

pub fn new(rx: UnboundedReceiver<Signal<Item, Err>>) -> FluxReceiver<Item, Err>

Create a new FluxReceiver.

pub fn boxed(self) -> Pin<Box<FluxReceiver<Item, Err>, Global>>

Create a Pin<Box> from a FluxReceiver.

pub fn none() -> FluxReceiver<Item, Err>

Create a new FluxReceiver that is immediately closed.

pub fn one<I, E>(item: Result<I, E>) -> FluxReceiver<I, E>where I: ConditionallySafe, E: ConditionallySafe,

Create a new FluxReceiver that is immediately closed with the passed item.

impl<Item, Err> FluxReceiver<Item, Err>where Item: ConditionallySafe, Err: ConditionallySafe,

pub fn recv( &self ) -> Pin<Box<dyn Future<Output = Result<Option<Result<Item, Err>>, Error>> + Sync + Send + 'static, Global>>where Err: ConditionallySafe, Item: ConditionallySafe,

Receive the next value from the FluxReceiver.

pub fn poll_recv(&self, cx: &mut Context<'_>) -> Poll<Option<Result<Item, Err>>>

Poll the FluxReceiver to see if there is a value available.

pub fn eject(&self) -> Option<FluxReceiver<Item, Err>>

Remove the inner channel from the FluxReceiver

Trait Implementations

impl<Err> AsyncRead for FluxReceiver<Bytes, Err>where Err: ConditionallySafe,

fn poll_read( self: Pin<&mut FluxReceiver<Bytes, Err>>, cx: &mut Context<'_>, buf: &mut [u8] ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>] ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<Err> AsyncRead for FluxReceiver<Vec<u8, Global>, Err>where Err: ConditionallySafe,

fn poll_read( self: Pin<&mut FluxReceiver<Vec<u8, Global>, Err>>, cx: &mut Context<'_>, buf: &mut [u8] ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>] ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<Item, Err> Clone for FluxReceiver<Item, Err>where Item: ConditionallySafe, Err: ConditionallySafe,

fn clone(&self) -> FluxReceiver<Item, Err>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Item, Err> Observable<Item, Err> for FluxReceiver<Item, Err>where Item: ConditionallySafe, Err: ConditionallySafe,

fn pipe(self, into: FluxChannel<Item, Err>) -> FluxPipe<Item, Err, Self>

Pipe one [Flux] into another.

impl<Item, Err> Stream for FluxReceiver<Item, Err>where Item: ConditionallySafe, Err: ConditionallySafe,

type Item = Result<Item, Err>

Values yielded by the stream.

fn poll_next( self: Pin<&mut FluxReceiver<Item, Err>>, cx: &mut Context<'_> ) -> Poll<Option<<FluxReceiver<Item, Err> as Stream>::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<Item, Err> TryFrom<FluxChannel<Item, Err>> for FluxReceiver<Item, Err>where Item: ConditionallySafe, Err: ConditionallySafe,

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: FluxChannel<Item, Err> ) -> Result<FluxReceiver<Item, Err>, <FluxReceiver<Item, Err> as TryFrom<FluxChannel<Item, Err>>>::Error>

Performs the conversion.