Struct futures_util::io::LineWriter

source · [−]

pub struct LineWriter<W: AsyncWrite> { /* private fields */ }

Expand description

Wrap a writer, like BufWriter does, but prioritizes buffering lines

This was written based on std::io::LineWriter which goes into further details explaining the code.

Buffering is actually done using BufWriter. This class will leverage BufWriter to write on-each-line.

Implementations

source

impl<W: AsyncWrite> LineWriter<W>

source

pub fn new(inner: W) -> LineWriter<W>

Create a new LineWriter with default buffer capacity. The default is currently 1KB which was taken from std::io::LineWriter

source

pub fn with_capacity(capacity: usize, inner: W) -> LineWriter<W>

Creates a new LineWriter with the specified buffer capacity.

source

pub fn buffer(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Returns a reference to buf_writer’s internally buffered data.

source

pub fn get_ref(&self) -> &W

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

Trait Implementations

source

impl<W: AsyncWrite> AsyncWrite for LineWriter<W>

source

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

Forward to buf_writer ’s BufWriter::poll_flush()

source

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

Forward to buf_writer ’s BufWriter::poll_close()

source

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

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

source

impl<W: Debug + AsyncWrite> Debug for LineWriter<W>

source

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

Formats the value using the given formatter. Read more

source

impl<'pin, W: AsyncWrite> Unpin for LineWriter<W> where
Origin<'__pin, W>: Unpin,

Auto Trait Implementations

impl<W> RefUnwindSafe for LineWriter<W> where
W: RefUnwindSafe,

impl<W> Send for LineWriter<W> where
W: Send,

impl<W> Sync for LineWriter<W> where
W: Sync,

impl<W> UnwindSafe for LineWriter<W> where
W: UnwindSafe,

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

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,

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,

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,

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,

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,

Attempts to write multiple buffers into this writer. Read more

source

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

Allow using an AsyncWrite as a Sink<Item: AsRef<[u8]>>. 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 futures_util::io::LineWriter

Implementations

impl<W: AsyncWrite> LineWriter<W>

pub fn new(inner: W) -> LineWriter<W>

pub fn with_capacity(capacity: usize, inner: W) -> LineWriter<W>

pub fn buffer(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

pub fn get_ref(&self) -> &W

Trait Implementations

impl<W: AsyncWrite> AsyncWrite for LineWriter<W>

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

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

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

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

impl<W: Debug + AsyncWrite> Debug for LineWriter<W>

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

impl<'__pin, W: AsyncWrite> Unpin for LineWriter<W> where __Origin<'__pin, W>: Unpin,

Auto Trait Implementations

impl<W> RefUnwindSafe for LineWriter<W> where W: RefUnwindSafe,

impl<W> Send for LineWriter<W> where W: Send,

impl<W> Sync for LineWriter<W> where W: Sync,

impl<W> UnwindSafe for LineWriter<W> where W: UnwindSafe,

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 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 into_sink<Item: AsRef<[u8]>>(self) -> IntoSink<Self, Item> where Self: Sized,

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>

pub fn buffer(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

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

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

impl<'pin, W: AsyncWrite> Unpin for LineWriter<W> where
Origin<'__pin, W>: Unpin,

impl<W> RefUnwindSafe for LineWriter<W> where
W: RefUnwindSafe,

impl<W> Send for LineWriter<W> where
W: Send,

impl<W> Sync for LineWriter<W> where
W: Sync,

impl<W> UnwindSafe for LineWriter<W> where
W: UnwindSafe,

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

impl<W> AsyncWriteExt for W where
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 into_sink<Item: AsRef<[u8 ]>>(self) -> IntoSink<Self, Item> where
Self: 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<T, U> TryFrom<U> for T where
U: Into<T>,

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