Struct flate2::read::GzEncoder [−][src]
A gzip streaming encoder
This structure exposes a Read
interface that will read uncompressed data
from the underlying reader and expose the compressed version as a Read
interface.
Examples
use std::io::prelude::*; use std::io; use flate2::Compression; use flate2::read::GzEncoder; // Return a vector containing the GZ compressed version of hello world fn gzencode_hello_world() -> io::Result<Vec<u8>> { let mut ret_vec = [0;100]; let bytestring = b"hello world"; let mut gz = GzEncoder::new(&bytestring[..], Compression::fast()); let count = gz.read(&mut ret_vec)?; Ok(ret_vec[0..count].to_vec()) }
Implementations
impl<R: Read> GzEncoder<R>
[src]
pub fn new(r: R, level: Compression) -> GzEncoder<R>ⓘ
[src]
Creates a new encoder which will use the given compression level.
The encoder is not configured specially for the emitted header. For
header configuration, see the GzBuilder
type.
The data read from the stream r
will be compressed and available
through the returned reader.
impl<R> GzEncoder<R>
[src]
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 reader.
Note that mutation of the reader may result in surprising results if this encoder is continued to be used.
pub fn into_inner(self) -> R
[src]
Returns the underlying stream, consuming this encoder
Trait Implementations
impl<R: Debug> Debug for GzEncoder<R>
[src]
impl<R: Read> Read for GzEncoder<R>
[src]
fn read(&mut self, into: &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<R: Read + Write> Write for GzEncoder<R>
[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 GzEncoder<R> where
R: RefUnwindSafe,
R: RefUnwindSafe,
impl<R> Send for GzEncoder<R> where
R: Send,
R: Send,
impl<R> Sync for GzEncoder<R> where
R: Sync,
R: Sync,
impl<R> Unpin for GzEncoder<R> where
R: Unpin,
R: Unpin,
impl<R> UnwindSafe for GzEncoder<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>,