[−][src]Struct snap::write::FrameEncoder
A writer for compressing a Snappy stream.
This FrameEncoder
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
impl<W: Write> FrameEncoder<W>
[src]
pub fn new(wtr: W) -> FrameEncoder<W>
[src]
Create a new writer for streaming Snappy compression.
pub fn into_inner(self) -> Result<W, IntoInnerError<FrameEncoder<W>>>
[src]
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.
pub fn get_ref(&self) -> &W
[src]
Gets a reference to the underlying writer in this encoder.
pub fn get_mut(&mut self) -> &mut W
[src]
Gets a reference to the underlying writer in this encoder.
Note that mutating the output/input state of the stream may corrupt this encoder, so care must be taken when using this method.
Trait Implementations
impl<W: Debug + Write> Debug for FrameEncoder<W>
[src]
impl<W: Write> Drop for FrameEncoder<W>
[src]
impl<W: Write> Write for FrameEncoder<W>
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
fn flush(&mut self) -> Result<()>
[src]
fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>
1.36.0[src]
fn is_write_vectored(&self) -> bool
[src]
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
fn write_all_vectored(&mut self, bufs: &mut [IoSlice]) -> Result<(), Error>
[src]
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Auto Trait Implementations
impl<W> RefUnwindSafe for FrameEncoder<W> where
W: RefUnwindSafe,
W: RefUnwindSafe,
impl<W> Send for FrameEncoder<W> where
W: Send,
W: Send,
impl<W> Sync for FrameEncoder<W> where
W: Sync,
W: Sync,
impl<W> Unpin for FrameEncoder<W> where
W: Unpin,
W: Unpin,
impl<W> UnwindSafe for FrameEncoder<W> where
W: UnwindSafe,
W: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,