Struct snap::Writer

source · [−]

pub struct Writer<W: Write> { /* private fields */ }

Expand description

A writer for compressing a Snappy stream.

This Writer wraps any other writer that implements io::Write. Bytes written to this writer are compressed using the Snappy frame format (file extension sz, MIME type application/x-snappy-framed).

Writes are buffered automatically, so there’s no need to wrap the given writer in a std::io::BufWriter.

The writer will be flushed automatically when it is dropped. If an error occurs, it is ignored.

Implementations

source

impl<W: Write> Writer<W>

source

pub fn new(wtr: W) -> Writer<W>

Create a new writer for streaming Snappy compression.

source

pub fn into_inner(self) -> Result<W, IntoInnerError<Writer<W>>>

Returns the underlying stream, consuming and flushing this writer.

If flushing the writer caused an error, then an IntoInnerError is returned, which contains both the writer and the original writer.

source

pub fn get_ref(&self) -> &W

Gets a reference to the underlying writer in this encoder.

Trait Implementations

source

impl<W: Write> Drop for Writer<W>

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl<W: Write> Write for Writer<W>

source

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

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

source

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

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

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

fn is_write_vectored(&self) -> bool

Determines if this Writer has an efficient write_vectored implementation. Read more

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

Attempts to write an entire buffer into this writer. Read more

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

Attempts to write multiple buffers into this writer. Read more

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

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

fn by_ref(&mut self) -> &mut Self

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

Auto Trait Implementations

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

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

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

impl<W> Unpin for Writer<W>where
W: Unpin,

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<W> WriteBytesExt for Wwhere
W: Write + ?Sized,

source

fn write_u8(&mut self, n: u8) -> Result<(), Error>

Writes an unsigned 8 bit integer to the underlying writer. Read more

source

fn write_i8(&mut self, n: i8) -> Result<(), Error>

Writes a signed 8 bit integer to the underlying writer. Read more

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

fn write_u128<T>(&mut self, n: u128) -> Result<(), Error>where
T: ByteOrder,

Writes an unsigned 128 bit integer to the underlying writer.

source

fn write_i128<T>(&mut self, n: i128) -> Result<(), Error>where
T: ByteOrder,

Writes a signed 128 bit integer to the underlying writer.

source

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

source

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

source

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

source

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

source

fn write_f32<T>(&mut self, n: f32) -> Result<(), Error>where
T: ByteOrder,

Writes a IEEE754 single-precision (4 bytes) floating point number to the underlying writer. Read more

source

fn write_f64<T>(&mut self, n: f64) -> Result<(), Error>where
T: ByteOrder,

Writes a IEEE754 double-precision (8 bytes) floating point number to the underlying writer. Read more

Struct snap::Writer

Implementations

impl<W: Write> Writer<W>

pub fn new(wtr: W) -> Writer<W>

pub fn into_inner(self) -> Result<W, IntoInnerError<Writer<W>>>

pub fn get_ref(&self) -> &W

Trait Implementations

impl<W: Write> Drop for Writer<W>

fn drop(&mut self)

impl<W: Write> Write for Writer<W>

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

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

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

fn is_write_vectored(&self) -> bool

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

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

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

fn by_ref(&mut self) -> &mut Self

Auto Trait Implementations

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

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

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

impl<W> Unpin for Writer<W>where W: Unpin,

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

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>

impl<W> WriteBytesExt for Wwhere W: Write + ?Sized,

fn write_u8(&mut self, n: u8) -> Result<(), Error>

fn write_i8(&mut self, n: i8) -> Result<(), Error>

fn write_u16<T>(&mut self, n: u16) -> Result<(), Error>where T: ByteOrder,

fn write_i16<T>(&mut self, n: i16) -> Result<(), Error>where T: ByteOrder,

fn write_u24<T>(&mut self, n: u32) -> Result<(), Error>where T: ByteOrder,

fn write_i24<T>(&mut self, n: i32) -> Result<(), Error>where T: ByteOrder,

fn write_u32<T>(&mut self, n: u32) -> Result<(), Error>where T: ByteOrder,

fn write_i32<T>(&mut self, n: i32) -> Result<(), Error>where T: ByteOrder,

fn write_u48<T>(&mut self, n: u64) -> Result<(), Error>where T: ByteOrder,

fn write_i48<T>(&mut self, n: i64) -> Result<(), Error>where T: ByteOrder,

fn write_u64<T>(&mut self, n: u64) -> Result<(), Error>where T: ByteOrder,

fn write_i64<T>(&mut self, n: i64) -> Result<(), Error>where T: ByteOrder,

fn write_u128<T>(&mut self, n: u128) -> Result<(), Error>where T: ByteOrder,

fn write_i128<T>(&mut self, n: i128) -> Result<(), Error>where T: ByteOrder,

fn write_uint<T>(&mut self, n: u64, nbytes: usize) -> Result<(), Error>where T: ByteOrder,

fn write_int<T>(&mut self, n: i64, nbytes: usize) -> Result<(), Error>where T: ByteOrder,

fn write_uint128<T>(&mut self, n: u128, nbytes: usize) -> Result<(), Error>where T: ByteOrder,

fn write_int128<T>(&mut self, n: i128, nbytes: usize) -> Result<(), Error>where T: ByteOrder,

fn write_f32<T>(&mut self, n: f32) -> Result<(), Error>where T: ByteOrder,

fn write_f64<T>(&mut self, n: f64) -> Result<(), Error>where T: ByteOrder,

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

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

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

impl<W> Unpin for Writer<W>where
W: Unpin,

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

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

impl<W> WriteBytesExt for Wwhere
W: Write + ?Sized,

fn write_u16<T>(&mut self, n: u16) -> Result<(), Error>where
T: ByteOrder,

fn write_i16<T>(&mut self, n: i16) -> Result<(), Error>where
T: ByteOrder,

fn write_u24<T>(&mut self, n: u32) -> Result<(), Error>where
T: ByteOrder,

fn write_i24<T>(&mut self, n: i32) -> Result<(), Error>where
T: ByteOrder,

fn write_u32<T>(&mut self, n: u32) -> Result<(), Error>where
T: ByteOrder,

fn write_i32<T>(&mut self, n: i32) -> Result<(), Error>where
T: ByteOrder,

fn write_u48<T>(&mut self, n: u64) -> Result<(), Error>where
T: ByteOrder,

fn write_i48<T>(&mut self, n: i64) -> Result<(), Error>where
T: ByteOrder,

fn write_u64<T>(&mut self, n: u64) -> Result<(), Error>where
T: ByteOrder,

fn write_i64<T>(&mut self, n: i64) -> Result<(), Error>where
T: ByteOrder,

fn write_u128<T>(&mut self, n: u128) -> Result<(), Error>where
T: ByteOrder,

fn write_i128<T>(&mut self, n: i128) -> Result<(), Error>where
T: ByteOrder,

fn write_uint<T>(&mut self, n: u64, nbytes: usize) -> Result<(), Error>where
T: ByteOrder,

fn write_int<T>(&mut self, n: i64, nbytes: usize) -> Result<(), Error>where
T: ByteOrder,

fn write_uint128<T>(&mut self, n: u128, nbytes: usize) -> Result<(), Error>where
T: ByteOrder,

fn write_int128<T>(&mut self, n: i128, nbytes: usize) -> Result<(), Error>where
T: ByteOrder,

fn write_f32<T>(&mut self, n: f32) -> Result<(), Error>where
T: ByteOrder,

fn write_f64<T>(&mut self, n: f64) -> Result<(), Error>where
T: ByteOrder,