Struct WithExtra 

pub struct WithExtra<T, Ex> { /* private fields */ }

Future/Stream/Sink with extra data attached.

Implementations

impl<T, Ex> WithExtra<T, Ex>

pub const fn new(inner: T, extra: Ex) -> Self

Attach extra data to a value.

pub fn into_inner(self) -> (T, Ex)

Unwrap into parts.

pub fn as_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>

Get a pinned mutable reference to the inner value.

Trait Implementations

impl<T, Ex> AsMut<T> for WithExtra<T, Ex>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T, Ex> AsRef<T> for WithExtra<T, Ex>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone, Ex: Clone> Clone for WithExtra<T, Ex>

fn clone(&self) -> WithExtra<T, Ex>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, Ex: Debug> Debug for WithExtra<T, Ex>

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

Formats the value using the given formatter.

impl<T: Default, Ex: Default> Default for WithExtra<T, Ex>

fn default() -> WithExtra<T, Ex>

Returns the “default value” for a type.

impl<Route, Msg, T: FlushRoute<Route, Msg>, Ex> FlushRoute<Route, Msg> for WithExtra<T, Ex>

Available on crate feature route-sink only.

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

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

impl<T, Ex> From<(T, Ex)> for WithExtra<T, Ex>

fn from((inner, extra): (T, Ex)) -> Self

Converts to this type from the input type.

impl<T, Ex: Default> From<T> for WithExtra<T, Ex>

fn from(inner: T) -> Self

Converts to this type from the input type.

impl<T, Ex> From<WithExtra<T, Ex>> for (T, Ex)

fn from(value: WithExtra<T, Ex>) -> Self

Converts to this type from the input type.

impl<T: FusedFuture, Ex> FusedFuture for WithExtra<T, Ex>

Available on crate feature futures-core only.

fn is_terminated(&self) -> bool

Returns true if the underlying future should no longer be polled.

impl<T: FusedStream, Ex> FusedStream for WithExtra<T, Ex>

Available on crate feature futures-core only.

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<T: Future, Ex> Future for WithExtra<T, Ex>

Available on crate feature futures-core only.

type Output = <T as Future>::Output

The type of value produced on completion.

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

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

impl<T: Hash, Ex: Hash> Hash for WithExtra<T, Ex>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq, Ex: PartialEq> PartialEq for WithExtra<T, Ex>

fn eq(&self, other: &WithExtra<T, Ex>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Route, Msg, T: ReadyRoute<Route, Msg>, Ex> ReadyRoute<Route, Msg> for WithExtra<T, Ex>

Available on crate feature route-sink only.

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

impl<Route, Msg, T: ReadySome<Route, Msg>, Ex> ReadySome<Route, Msg> for WithExtra<T, Ex>

Available on crate feature route-sink only.

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

impl<Item, T: Sink<Item>, Ex> Sink<Item> for WithExtra<T, Ex>

Available on crate feature futures-sink only.

type Error = <T as Sink<Item>>::Error

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

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

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Item) -> 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(())).

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

Flush any remaining output from this sink.

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

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

impl<T: Stream, Ex> Stream for WithExtra<T, Ex>

Available on crate feature futures-core only.

type Item = <T as Stream>::Item

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::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<T: Copy, Ex: Copy> Copy for WithExtra<T, Ex>

impl<T: Eq, Ex: Eq> Eq for WithExtra<T, Ex>

impl<T, Ex> StructuralPartialEq for WithExtra<T, Ex>

impl<'pin, T, Ex> Unpin for WithExtra<T, Ex>

where PinnedFieldsOf<__WithExtra<'pin, T, Ex>>: Unpin,