Struct flate2::bufread::DeflateEncoder [−][src]
A DEFLATE encoder, or compressor.
This structure consumes a BufRead
interface, reading uncompressed data
from the underlying reader, and emitting compressed data.
Examples
use std::io::prelude::*; use std::io; use flate2::Compression; use flate2::bufread::DeflateEncoder; use std::fs::File; use std::io::BufReader; // Opens sample file, compresses the contents and returns a Vector fn open_hello_world() -> io::Result<Vec<u8>> { let f = File::open("examples/hello_world.txt")?; let b = BufReader::new(f); let mut deflater = DeflateEncoder::new(b, Compression::fast()); let mut buffer = Vec::new(); deflater.read_to_end(&mut buffer)?; Ok(buffer) }
Implementations
impl<R: BufRead> DeflateEncoder<R>
[src]
pub fn new(r: R, level: Compression) -> DeflateEncoder<R>ⓘNotable traits for DeflateEncoder<R>
impl<R: BufRead> Read for DeflateEncoder<R>impl<W: BufRead + Write> Write for DeflateEncoder<W>
[src]
Notable traits for DeflateEncoder<R>
impl<R: BufRead> Read for DeflateEncoder<R>impl<W: BufRead + Write> Write for DeflateEncoder<W>
Creates a new encoder which will read uncompressed data from the given stream and emit the compressed stream.
impl<R> DeflateEncoder<R>
[src]
pub fn reset(&mut self, r: R) -> R
[src]
Resets the state of this encoder entirely, swapping out the input stream for another.
This function will reset the internal state of this encoder and replace
the input stream with the one provided, returning the previous input
stream. Future data read from this encoder will be the compressed
version of r
’s data.
pub fn get_ref(&self) -> &R
[src]
Acquires a reference to the underlying reader
pub fn get_mut(&mut self) -> &mut R
[src]
Acquires a mutable reference to the underlying stream
Note that mutation of the stream may result in surprising results if this encoder is continued to be used.
pub fn into_inner(self) -> R
[src]
Consumes this encoder, returning the underlying reader.
pub fn total_in(&self) -> u64
[src]
Returns the number of bytes that have been read into this compressor.
Note that not all bytes read from the underlying object may be accounted for, there may still be some active buffering.
pub fn total_out(&self) -> u64
[src]
Returns the number of bytes that the compressor has produced.
Note that not all bytes may have been read yet, some may still be buffered.
Trait Implementations
impl<R: Debug> Debug for DeflateEncoder<R>
[src]
impl<R: BufRead> Read for DeflateEncoder<R>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
pub fn read_vectored(
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
1.36.0[src]
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
pub fn is_read_vectored(&self) -> bool
[src]
pub unsafe fn initializer(&self) -> Initializer
[src]
pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]
pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
pub fn by_ref(&mut self) -> &mut Self
1.0.0[src]
pub fn bytes(self) -> Bytes<Self>
1.0.0[src]
pub fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
pub fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
impl<W: BufRead + Write> Write for DeflateEncoder<W>
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
fn flush(&mut self) -> Result<()>
[src]
pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>
1.36.0[src]
pub fn is_write_vectored(&self) -> bool
[src]
pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
pub fn write_all_vectored(
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>
[src]
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>
pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>
1.0.0[src]
pub fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Auto Trait Implementations
impl<R> RefUnwindSafe for DeflateEncoder<R> where
R: RefUnwindSafe,
R: RefUnwindSafe,
impl<R> Send for DeflateEncoder<R> where
R: Send,
R: Send,
impl<R> Sync for DeflateEncoder<R> where
R: Sync,
R: Sync,
impl<R> Unpin for DeflateEncoder<R> where
R: Unpin,
R: Unpin,
impl<R> UnwindSafe for DeflateEncoder<R> where
R: UnwindSafe,
R: 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,
pub 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.
pub 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>,