Struct async_std::io::Sink

source · [−]

pub struct Sink { /* private fields */ }

Expand description

A writer that consumes and drops all data.

This writer is constructed by the sink function. See its documentation for more.

Trait Implementations

source

impl AsyncWrite for Sink

source

fn poll_write(
 self: Pin<&mut Self>,
 _: &mut Context<'_>,
 buf: &[u8]
) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object. Read more

source

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

Attempt to flush the object, ensuring that any buffered data reach their destination. Read more

source

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

Attempt to close the object. Read more

source

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

Attempt to write bytes from bufs into the object using vectored IO operations. Read more

source

impl Debug for Sink

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl RefUnwindSafe for Sink

impl Send for Sink

impl Sync for Sink

impl Unpin for Sink

impl UnwindSafe for Sink

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<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,

source

fn write(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>ⓘNotable traits for WriteFuture<'_, W>`impl<'_, W> Future for WriteFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>;` where
Self: Unpin,

Writes some bytes into the byte stream. Read more

source

fn write_vectored(
 &'a mut self,
 bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self>ⓘNotable traits for WriteVectoredFuture<'_, W>`impl<'_, W> Future for WriteVectoredFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>;` where
 Self: Unpin,

Like write(), except that it writes a slice of buffers. Read more

source

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>ⓘNotable traits for WriteAllFuture<'_, W>`impl<'_, W> Future for WriteAllFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>;` where
Self: Unpin,

Writes an entire buffer into the byte stream. Read more

source

fn flush(&mut self) -> FlushFuture<'_, Self>ⓘNotable traits for FlushFuture<'_, W>`impl<'_, W> Future for FlushFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>;` where
Self: Unpin,

Flushes the stream to ensure that all buffered contents reach their destination. Read more

source

fn close(&mut self) -> CloseFuture<'_, Self>ⓘNotable traits for CloseFuture<'_, W>`impl<'_, W> Future for CloseFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>;` where
Self: Unpin,

Closes the writer. Read more

source

fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a, Global>>ⓘNotable traits for Pin`impl Future for Pin where P: DerefMut, ::Target: Future, type Output = <::Target as Future>::Output;` where
Self: 'a + Send,

Boxes the writer and changes its type to dyn AsyncWrite + Send + 'a. 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, 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 async_std::io::Sink

Trait Implementations

impl AsyncWrite for Sink

fn poll_write(
    self: Pin<&mut Self>,
    _: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize>>

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

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

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

impl Debug for Sink

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

Auto Trait Implementations

impl RefUnwindSafe for Sink

impl Send for Sink

impl Sync for Sink

impl Unpin for Sink

impl UnwindSafe for Sink

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,

fn write(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>ⓘNotable traits for WriteFuture<'_, W>`impl<'_, W> Future for WriteFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>;` where
Self: Unpin,

fn write_vectored(
    &'a mut self,
    bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self>ⓘNotable traits for WriteVectoredFuture<'_, W>`impl<'_, W> Future for WriteVectoredFuture<'_, W> where     W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>;` where
    Self: Unpin,

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>ⓘNotable traits for WriteAllFuture<'_, W>`impl<'_, W> Future for WriteAllFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>;` where
Self: Unpin,

fn flush(&mut self) -> FlushFuture<'_, Self>ⓘNotable traits for FlushFuture<'_, W>`impl<'_, W> Future for FlushFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>;` where
Self: Unpin,

fn close(&mut self) -> CloseFuture<'_, Self>ⓘNotable traits for CloseFuture<'_, W>`impl<'_, W> Future for CloseFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>;` where
Self: Unpin,

fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a, Global>>ⓘNotable traits for Pin<P>`impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;` where
Self: 'a + Send,

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

Struct async_std::io::Sink

Trait Implementations

impl AsyncWrite for Sink

fn poll_write( self: Pin<&mut Self>, _: &mut Context<'_>, buf: &[u8]) -> Poll<Result<usize>>

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

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

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

impl Debug for Sink

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

Auto Trait Implementations

impl RefUnwindSafe for Sink

impl Send for Sink

impl Sync for Sink

impl Unpin for Sink

impl UnwindSafe for Sink

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<W> AsyncWriteExt for W where W: AsyncWrite + ?Sized,

fn write(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>ⓘNotable traits for WriteFuture<'_, W>impl<'_, W> Future for WriteFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>; where Self: Unpin,

fn write_vectored( &'a mut self, bufs: &'a [IoSlice<'a>]) -> WriteVectoredFuture<'a, Self>ⓘNotable traits for WriteVectoredFuture<'_, W>impl<'_, W> Future for WriteVectoredFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>; where Self: Unpin,

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>ⓘNotable traits for WriteAllFuture<'_, W>impl<'_, W> Future for WriteAllFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>; where Self: Unpin,

fn flush(&mut self) -> FlushFuture<'_, Self>ⓘNotable traits for FlushFuture<'_, W>impl<'_, W> Future for FlushFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>; where Self: Unpin,

fn close(&mut self) -> CloseFuture<'_, Self>ⓘNotable traits for CloseFuture<'_, W>impl<'_, W> Future for CloseFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>; where Self: Unpin,

fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a, Global>>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output; where Self: 'a + Send,

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

fn poll_write(
self: Pin<&mut Self>,
_: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>

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

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

impl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,

fn write(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>ⓘNotable traits for WriteFuture<'_, W>`impl<'_, W> Future for WriteFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>;` where
Self: Unpin,

fn write_vectored(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self>ⓘNotable traits for WriteVectoredFuture<'_, W>`impl<'_, W> Future for WriteVectoredFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<usize, Error>;` where
Self: Unpin,

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>ⓘNotable traits for WriteAllFuture<'_, W>`impl<'_, W> Future for WriteAllFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>;` where
Self: Unpin,

fn flush(&mut self) -> FlushFuture<'_, Self>ⓘNotable traits for FlushFuture<'_, W>`impl<'_, W> Future for FlushFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>;` where
Self: Unpin,

fn close(&mut self) -> CloseFuture<'_, Self>ⓘNotable traits for CloseFuture<'_, W>`impl<'_, W> Future for CloseFuture<'_, W> where W: AsyncWrite + Unpin + ?Sized, type Output = Result<(), Error>;` where
Self: Unpin,

fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a, Global>>ⓘNotable traits for Pin<P>`impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;` where
Self: 'a + Send,

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

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