Struct pgp::line_writer::LineWriter

pub struct LineWriter<'a, W, N>where
    W: Write,
    N: Unsigned + ArrayLength<u8> + Add<U2>,
    Sum<N, U2>: ArrayLength<u8>,{ /* private fields */ }

A Write implementation that splits any written bytes into the given length lines.

Panics

Calling write() after finish() is invalid and will panic.

Implementations

impl<'a, W, N> LineWriter<'a, W, N>where W: 'a + Write, N: Unsigned + ArrayLength<u8> + Add<U2>, Sum<N, U2>: ArrayLength<u8>,

pub fn new(w: &'a mut W, line_break: LineBreak) -> Self

Creates a new encoder around an existing writer.

pub fn finish(&mut self) -> Result<()>

Write all remaining buffered data.

Once this succeeds, no further writes can be performed.

Errors

Assuming the wrapped writer obeys the Write contract, if this returns Err, no data was written, and finish() may be retried if appropriate for the type of error, etc.

Trait Implementations

impl<'a, W, N> Drop for LineWriter<'a, W, N>where W: 'a + Write, N: Unsigned + ArrayLength<u8> + Add<U2>, Sum<N, U2>: ArrayLength<u8>,

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, W, N> Write for LineWriter<'a, W, N>where W: 'a + Write, N: Unsigned + ArrayLength<u8> + Add<U2>, Sum<N, U2>: ArrayLength<u8>,

fn flush(&mut self) -> Result<()>

Because this is usually treated as OK to call multiple times, it will not flush any incomplete chunks of input or write padding.

fn write(&mut self, input: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adapter for this instance of Write.