Struct ore::future::DevNull[−][src]

pub struct DevNull<T, E>(PhantomData<T>, PhantomData<E>);

This is supported on crate feature network only.

Expand description

A sink that consumes its input and sends it nowhere.

Primarily useful as a base sink when folding multiple sinks into one using futures::sink::SinkExt::fanout.

Tuple Fields

0: PhantomData<T>1: PhantomData<E>

Trait Implementations

[src]

impl<T: Debug, E: Debug> Debug for DevNull<T, E>

[src]

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

Formats the value using the given formatter. Read more

[src]

impl<T, E> Sink<T> for DevNull<T, E>

type Error = E

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

[src]

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

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

[src]

fn start_send(self: Pin<&mut Self>, _: T) -> 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

[src]

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

Flush any remaining output from this sink. Read more

[src]

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

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

Auto Trait Implementations

impl<T, E> RefUnwindSafe for DevNull<T, E> where
E: RefUnwindSafe,
T: RefUnwindSafe,

impl<T, E> Send for DevNull<T, E> where
E: Send,
T: Send,

impl<T, E> Sync for DevNull<T, E> where
E: Sync,
T: Sync,

impl<T, E> Unpin for DevNull<T, E> where
E: Unpin,
T: Unpin,

impl<T, E> UnwindSafe for DevNull<T, E> where
E: UnwindSafe,
T: UnwindSafe,

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

[src]

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<S, T> OreSinkExt<T> for S where
S: Sink<T>,

[src]

fn boxed(self) -> Box<dyn Sink<T, Error = Self::Error> + Send> where
Self: Sized + Send + 'static,

This is supported on crate feature network only.

Boxes this sink.

[src]

fn enqueue(&mut self, item: T) -> Enqueue<'_, Self, T>ⓘ
Notable traits for Enqueue<'_, Si, Item>
`impl<Si, Item> Future for Enqueue<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, Item: Unpin, type Output = Result<(), Si::Error>;`

This is supported on crate feature network only.

Like futures::sink::SinkExt::send, but does not flush the sink after enqueuing item. Read more

[src]

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

[src]

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

[src]

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

[src]

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.

[src]

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

[src]

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

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

[src]

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

Close the sink.

[src]

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

[src]

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

Flush the sink, processing all pending items. Read more

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

[src]

impl<T> WithSubscriber for T

[src]

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

[src]

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct ore::future::DevNull[−][src]

Tuple Fields

Trait Implementations

impl<T: Debug, E: Debug> Debug for DevNull<T, E>

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

impl<T, E> Sink<T> for DevNull<T, E>

type Error = E

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

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

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

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

Auto Trait Implementations

impl<T, E> RefUnwindSafe for DevNull<T, E> where E: RefUnwindSafe, T: RefUnwindSafe,

impl<T, E> Send for DevNull<T, E> where E: Send, T: Send,

impl<T, E> Sync for DevNull<T, E> where E: Sync, T: Sync,

impl<T, E> Unpin for DevNull<T, E> where E: Unpin, T: Unpin,

impl<T, E> UnwindSafe for DevNull<T, E> where E: UnwindSafe, T: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<S, T> OreSinkExt<T> for S where S: Sink<T>,

fn boxed(self) -> Box<dyn Sink<T, Error = Self::Error> + Send> where Self: Sized + Send + 'static,

fn enqueue(&mut self, item: T) -> Enqueue<'_, Self, T>ⓘNotable traits for Enqueue<'_, Si, Item>impl<Si, Item> Future for Enqueue<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, Item: Unpin, type Output = Result<(), Si::Error>;

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

type Error = Infallible

pub 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

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

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

impl<T, E> RefUnwindSafe for DevNull<T, E> where
E: RefUnwindSafe,
T: RefUnwindSafe,

impl<T, E> Send for DevNull<T, E> where
E: Send,
T: Send,

impl<T, E> Sync for DevNull<T, E> where
E: Sync,
T: Sync,

impl<T, E> Unpin for DevNull<T, E> where
E: Unpin,
T: Unpin,

impl<T, E> UnwindSafe for DevNull<T, E> where
E: UnwindSafe,
T: UnwindSafe,

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<S, T> OreSinkExt<T> for S where
S: Sink<T>,

fn boxed(self) -> Box<dyn Sink<T, Error = Self::Error> + Send> where
Self: Sized + Send + 'static,

fn enqueue(&mut self, item: T) -> Enqueue<'_, Self, T>ⓘ
Notable traits for Enqueue<'_, Si, Item>
`impl<Si, Item> Future for Enqueue<'_, Si, Item> where Si: Sink<Item> + Unpin + ?Sized, Item: Unpin, type Output = Result<(), Si::Error>;`

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

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,