Struct Inspect

#[must_use = "futures/streams/sinks do nothing unless you `.await` or poll them"]
pub struct Inspect<St, F> { /* private fields */ }

Stream for the inspect method.

Implementations

impl<St, F> Inspect<St, F>

fn get_ref(&self) -> &St

Acquires a reference to the underlying sink or stream that this combinator is pulling from.

fn get_mut(&mut self) -> &mut St

Acquires a mutable reference to the underlying sink or stream that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the sink or stream which may otherwise confuse this combinator.

fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut St>

Acquires a pinned mutable reference to the underlying sink or stream that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the sink or stream which may otherwise confuse this combinator.

fn into_inner(self) -> St

Consumes this combinator, returning the underlying sink or stream.

Note that this may discard intermediate state of this combinator, so care should be taken to avoid losing resources when this is called.

Trait Implementations

impl<'__pin, St, F> Unpin for Inspect<St, F> where PinnedFieldsOf<__Origin<'__pin, St, F>>: Unpin,

impl<St, F> Debug for Inspect<St, F> where Map<St, InspectFn<F>>: Debug,

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

impl<St, F> FusedStream for Inspect<St, F> where Map<St, InspectFn<F>>: FusedStream,

fn is_terminated(&self) -> bool

impl<St, F> Stream for Inspect<St, F> where Map<St, InspectFn<F>>: Stream,

type Item = <Map<St, InspectFn<F>> as Stream>::Item;
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>>
fn size_hint(&self) -> (usize, Option<usize>)

impl<_Item, St, F> Sink<_Item> for Inspect<St, F> where Map<St, InspectFn<F>>: Sink<_Item>,

type Error = <Map<St, InspectFn<F>> as Sink<_Item>>::Error;
fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>
fn start_send(self: Pin<&mut Self>, item: _Item) -> 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>>

Auto Trait Implementations

impl<St, F> Freeze for Inspect<St, F> where Map<St, InspectFn<F>>: Freeze,

impl<St, F> RefUnwindSafe for Inspect<St, F> where Map<St, InspectFn<F>>: RefUnwindSafe,

impl<St, F> Send for Inspect<St, F> where Map<St, InspectFn<F>>: Send,

impl<St, F> Sync for Inspect<St, F> where Map<St, InspectFn<F>>: Sync,

impl<St, F> UnsafeUnpin for Inspect<St, F> where Map<St, InspectFn<F>>: UnsafeUnpin,

impl<St, F> UnwindSafe for Inspect<St, F> where Map<St, InspectFn<F>>: UnwindSafe,

Blanket Implementations

impl<S> TryStreamExt for Inspect<St, F> where S: TryStream + ?Sized,

impl<S, T, E> TryStream for Inspect<St, F> where S: Stream<Item = Result<T, E>> + ?Sized,

type Ok = T;
type Error = E;
fn try_poll_next(self: Pin<&mut S>, cx: &mut Context<'_>) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

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

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Inspect<St, F> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Inspect<St, F> where T: ?Sized,

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

impl<T> From<T> for Inspect<St, F>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> StreamExt for Inspect<St, F> where T: Stream + ?Sized,

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

impl<T, U> Into<U> for Inspect<St, F> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for Inspect<St, F> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for Inspect<St, F> where U: TryFrom<T>,

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