Struct futures_util::io::Sink

source · [−]

pub struct Sink { /* private fields */ }

Available on crate feature io only.

Expand description

Writer for the sink() function.

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_write_vectored(
 self: Pin<&mut Self>,
 _: &mut Context<'_>,
 bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>

Attempt to write bytes from bufs into the object using vectored IO operations. 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

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 Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

source

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

Available on crate feature io only.

Creates a future which will entirely flush this AsyncWrite. Read more

source

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

Available on crate feature io only.

Creates a future which will entirely close this AsyncWrite.

source

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

Available on crate feature io only.

Creates a future which will write bytes from buf into the object. Read more

source

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

Available on crate feature io only.

Creates a future which will write bytes from bufs into the object using vectored IO operations. Read more

source

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

Available on crate feature io only.

Write data into this object. Read more

source

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

Available on crate feature io only.

Attempts to write multiple buffers into this writer. Read more

source

fn compat_write(self) -> Compat<Self>ⓘNotable traits for Compat<R>`impl<R: AsyncRead03 + Unpin> Read for Compat<R>impl<W: AsyncWrite03 + Unpin> Write for Compat<W>`where
Self: Sized + Unpin,

Available on crate features io and io-compat only.

Wraps an AsyncWrite in a compatibility wrapper that allows it to be used as a futures 0.1 / tokio-io 0.1 AsyncWrite. Requires the io-compat feature to enable. Read more

source

fn into_sink<Item: AsRef<[u8]>>(self) -> IntoSink<Self, Item>where
Self: Sized,

Available on crate features io and sink only.

Allow using an AsyncWrite as a Sink<Item: AsRef<[u8]>>. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
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 Twhere
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 Twhere
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 Twhere
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 futures_util::io::Sink

Trait Implementations

impl AsyncWrite for Sink

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

fn poll_write_vectored( self: Pin<&mut Self>, _: &mut Context<'_>, bufs: &[IoSlice<'_>]) -> 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<()>>

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 Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

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

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

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

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

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

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

fn compat_write(self) -> Compat<Self>ⓘNotable traits for Compat<R>impl<R: AsyncRead03 + Unpin> Read for Compat<R>impl<W: AsyncWrite03 + Unpin> Write for Compat<W>where Self: Sized + Unpin,

fn into_sink<Item: AsRef<[u8]>>(self) -> IntoSink<Self, Item>where Self: Sized,

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

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere 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 Twhere U: From<T>,

fn into(self) -> U

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

type Error = Infallible

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

impl<T, U> TryInto<U> for Twhere 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>,
_: &mut Context<'_>,
bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>

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

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

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

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

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

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

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

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

fn compat_write(self) -> Compat<Self>ⓘNotable traits for Compat<R>`impl<R: AsyncRead03 + Unpin> Read for Compat<R>impl<W: AsyncWrite03 + Unpin> Write for Compat<W>`where
Self: Sized + Unpin,

fn into_sink<Item: AsRef<[u8]>>(self) -> IntoSink<Self, Item>where
Self: Sized,

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

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

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

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

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