Struct pgp::line_writer::LineWriter
source · [−]pub struct LineWriter<'a, W, N> where
W: Write,
N: Unsigned + ArrayLength<u8>,
N: Add<U2>,
Sum<N, U2>: ArrayLength<u8>, { /* private fields */ }
Expand description
A Write
implementation that splits any written bytes into the given length lines.
Panics
Calling write()
after finish()
is invalid and will panic.
Implementations
sourceimpl<'a, W, N> LineWriter<'a, W, N> where
W: 'a + Write,
N: Unsigned + ArrayLength<u8>,
N: Add<U2>,
Sum<N, U2>: ArrayLength<u8>,
impl<'a, W, N> LineWriter<'a, W, N> where
W: 'a + Write,
N: Unsigned + ArrayLength<u8>,
N: Add<U2>,
Sum<N, U2>: ArrayLength<u8>,
sourcepub fn new(w: &'a mut W, line_break: LineBreak) -> Self
pub fn new(w: &'a mut W, line_break: LineBreak) -> Self
Creates a new encoder around an existing writer.
sourcepub fn finish(&mut self) -> Result<()>
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
sourceimpl<'a, W, N> Drop for LineWriter<'a, W, N> where
W: 'a + Write,
N: Unsigned + ArrayLength<u8>,
N: Add<U2>,
Sum<N, U2>: ArrayLength<u8>,
impl<'a, W, N> Drop for LineWriter<'a, W, N> where
W: 'a + Write,
N: Unsigned + ArrayLength<u8>,
N: Add<U2>,
Sum<N, U2>: ArrayLength<u8>,
sourceimpl<'a, W, N> Write for LineWriter<'a, W, N> where
W: 'a + Write,
N: Unsigned + ArrayLength<u8>,
N: Add<U2>,
Sum<N, U2>: ArrayLength<u8>,
impl<'a, W, N> Write for LineWriter<'a, W, N> where
W: 'a + Write,
N: Unsigned + ArrayLength<u8>,
N: Add<U2>,
Sum<N, U2>: ArrayLength<u8>,
sourcefn flush(&mut self) -> Result<()>
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.
sourcefn write(&mut self, input: &[u8]) -> Result<usize>
fn write(&mut self, input: &[u8]) -> Result<usize>
Write a buffer into this writer, returning how many bytes were written. Read more
sourcefn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)Determines if this Write
r has an efficient write_vectored
implementation. Read more
1.0.0 · sourcefn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Attempts to write an entire buffer into this writer. Read more
sourcefn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored
)Attempts to write multiple buffers into this writer. Read more
Auto Trait Implementations
impl<'a, W, N> RefUnwindSafe for LineWriter<'a, W, N> where
W: RefUnwindSafe,
<N as ArrayLength<u8>>::ArrayType: RefUnwindSafe,
<<N as Add<UInt<UInt<UTerm, B1>, B0>>>::Output as ArrayLength<u8>>::ArrayType: RefUnwindSafe,
impl<'a, W, N> Send for LineWriter<'a, W, N> where
W: Send,
impl<'a, W, N> Sync for LineWriter<'a, W, N> where
W: Sync,
impl<'a, W, N> Unpin for LineWriter<'a, W, N> where
<N as ArrayLength<u8>>::ArrayType: Unpin,
<<N as Add<UInt<UInt<UTerm, B1>, B0>>>::Output as ArrayLength<u8>>::ArrayType: Unpin,
impl<'a, W, N> !UnwindSafe for LineWriter<'a, W, N>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<W> WriteBytesExt for W where
W: Write + ?Sized,
impl<W> WriteBytesExt for W where
W: Write + ?Sized,
sourcefn write_u8(&mut self, n: u8) -> Result<(), Error>
fn write_u8(&mut self, n: u8) -> Result<(), Error>
Writes an unsigned 8 bit integer to the underlying writer. Read more
sourcefn write_i8(&mut self, n: i8) -> Result<(), Error>
fn write_i8(&mut self, n: i8) -> Result<(), Error>
Writes a signed 8 bit integer to the underlying writer. Read more
sourcefn write_u16<T>(&mut self, n: u16) -> Result<(), Error> where
T: ByteOrder,
fn write_u16<T>(&mut self, n: u16) -> Result<(), Error> where
T: ByteOrder,
Writes an unsigned 16 bit integer to the underlying writer. Read more
sourcefn write_i16<T>(&mut self, n: i16) -> Result<(), Error> where
T: ByteOrder,
fn write_i16<T>(&mut self, n: i16) -> Result<(), Error> where
T: ByteOrder,
Writes a signed 16 bit integer to the underlying writer. Read more
sourcefn write_u24<T>(&mut self, n: u32) -> Result<(), Error> where
T: ByteOrder,
fn write_u24<T>(&mut self, n: u32) -> Result<(), Error> where
T: ByteOrder,
Writes an unsigned 24 bit integer to the underlying writer. Read more
sourcefn write_i24<T>(&mut self, n: i32) -> Result<(), Error> where
T: ByteOrder,
fn write_i24<T>(&mut self, n: i32) -> Result<(), Error> where
T: ByteOrder,
Writes a signed 24 bit integer to the underlying writer. Read more
sourcefn write_u32<T>(&mut self, n: u32) -> Result<(), Error> where
T: ByteOrder,
fn write_u32<T>(&mut self, n: u32) -> Result<(), Error> where
T: ByteOrder,
Writes an unsigned 32 bit integer to the underlying writer. Read more
sourcefn write_i32<T>(&mut self, n: i32) -> Result<(), Error> where
T: ByteOrder,
fn write_i32<T>(&mut self, n: i32) -> Result<(), Error> where
T: ByteOrder,
Writes a signed 32 bit integer to the underlying writer. Read more
sourcefn write_u48<T>(&mut self, n: u64) -> Result<(), Error> where
T: ByteOrder,
fn write_u48<T>(&mut self, n: u64) -> Result<(), Error> where
T: ByteOrder,
Writes an unsigned 48 bit integer to the underlying writer. Read more
sourcefn write_i48<T>(&mut self, n: i64) -> Result<(), Error> where
T: ByteOrder,
fn write_i48<T>(&mut self, n: i64) -> Result<(), Error> where
T: ByteOrder,
Writes a signed 48 bit integer to the underlying writer. Read more
sourcefn write_u64<T>(&mut self, n: u64) -> Result<(), Error> where
T: ByteOrder,
fn write_u64<T>(&mut self, n: u64) -> Result<(), Error> where
T: ByteOrder,
Writes an unsigned 64 bit integer to the underlying writer. Read more
sourcefn write_i64<T>(&mut self, n: i64) -> Result<(), Error> where
T: ByteOrder,
fn write_i64<T>(&mut self, n: i64) -> Result<(), Error> where
T: ByteOrder,
Writes a signed 64 bit integer to the underlying writer. Read more
sourcefn write_u128<T>(&mut self, n: u128) -> Result<(), Error> where
T: ByteOrder,
fn write_u128<T>(&mut self, n: u128) -> Result<(), Error> where
T: ByteOrder,
Writes an unsigned 128 bit integer to the underlying writer.
sourcefn write_i128<T>(&mut self, n: i128) -> Result<(), Error> where
T: ByteOrder,
fn write_i128<T>(&mut self, n: i128) -> Result<(), Error> where
T: ByteOrder,
Writes a signed 128 bit integer to the underlying writer.
sourcefn write_uint<T>(&mut self, n: u64, nbytes: usize) -> Result<(), Error> where
T: ByteOrder,
fn write_uint<T>(&mut self, n: u64, nbytes: usize) -> Result<(), Error> where
T: ByteOrder,
Writes an unsigned n-bytes integer to the underlying writer. Read more
sourcefn write_int<T>(&mut self, n: i64, nbytes: usize) -> Result<(), Error> where
T: ByteOrder,
fn write_int<T>(&mut self, n: i64, nbytes: usize) -> Result<(), Error> where
T: ByteOrder,
Writes a signed n-bytes integer to the underlying writer. Read more
sourcefn write_uint128<T>(&mut self, n: u128, nbytes: usize) -> Result<(), Error> where
T: ByteOrder,
fn write_uint128<T>(&mut self, n: u128, nbytes: usize) -> Result<(), Error> where
T: ByteOrder,
Writes an unsigned n-bytes integer to the underlying writer. Read more
sourcefn write_int128<T>(&mut self, n: i128, nbytes: usize) -> Result<(), Error> where
T: ByteOrder,
fn write_int128<T>(&mut self, n: i128, nbytes: usize) -> Result<(), Error> where
T: ByteOrder,
Writes a signed n-bytes integer to the underlying writer. Read more