Struct flate2::bufread::GzEncoder

source ·
pub struct GzEncoder<R> { /* private fields */ }
Expand description

A gzip streaming encoder

This structure exposes a BufRead interface that will read uncompressed data from the underlying reader and expose the compressed version as a BufRead interface.

Examples

use std::io::prelude::*;
use std::io;
use flate2::Compression;
use flate2::bufread::GzEncoder;
use std::fs::File;
use std::io::BufReader;

// Opens sample file, compresses the contents and returns a Vector or error
// File wrapped in a BufReader implements BufRead

fn open_hello_world() -> io::Result<Vec<u8>> {
    let f = File::open("examples/hello_world.txt")?;
    let b = BufReader::new(f);
    let mut gz = GzEncoder::new(b, Compression::Fast);
    let mut buffer = Vec::new();
    gz.read_to_end(&mut buffer)?;
    Ok(buffer)
}

Implementations§

source§

impl<R: BufRead> GzEncoder<R>

source

pub fn new(r: R, level: Compression) -> GzEncoder<R>

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 Builder type.

The data read from the stream r will be compressed and available through the returned reader.

source§

impl<R> GzEncoder<R>

source

pub fn get_ref(&self) -> &R

Acquires a reference to the underlying reader.

source

pub fn get_mut(&mut self) -> &mut R

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.

source

pub fn into_inner(self) -> R

Returns the underlying stream, consuming this encoder

Trait Implementations§

source§

impl<R: Debug> Debug for GzEncoder<R>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<R: BufRead> Read for GzEncoder<R>

source§

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
1.36.0 · source§

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

Like read, except that it reads into a slice of buffers. Read more
source§

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Reader has an efficient read_vectored implementation. Read more
1.0.0 · source§

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf. Read more
1.0.0 · source§

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf. Read more
1.6.0 · source§

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

Read the exact number of bytes required to fill buf. Read more
source§

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Pull some bytes from this source into the specified buffer. Read more
source§

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Read the exact number of bytes required to fill cursor. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · source§

fn bytes(self) -> Bytes<Self>where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · source§

fn chain<R>(self, next: R) -> Chain<Self, R>where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another. Read more
1.0.0 · source§

fn take(self, limit: u64) -> Take<Self>where Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more
source§

impl<R: BufRead + Write> Write for GzEncoder<R>

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
1.36.0 · source§

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

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

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 · source§

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

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

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

🔬This is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

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

Auto Trait Implementations§

§

impl<R> RefUnwindSafe for GzEncoder<R>where R: RefUnwindSafe,

§

impl<R> Send for GzEncoder<R>where R: Send,

§

impl<R> Sync for GzEncoder<R>where R: Sync,

§

impl<R> Unpin for GzEncoder<R>where R: Unpin,

§

impl<R> UnwindSafe for GzEncoder<R>where R: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> FlateReadExt for Twhere T: Read,

source§

fn gz_encode(self, lvl: Compression) -> GzEncoder<Self>

Consume this reader to create a compression stream at the specified compression level.
source§

fn gz_decode(self) -> Result<GzDecoder<Self>>

Consume this reader to create a decompression stream of this stream.
source§

fn zlib_encode(self, lvl: Compression) -> ZlibEncoder<Self>

Consume this reader to create a compression stream at the specified compression level.
source§

fn zlib_decode(self) -> ZlibDecoder<Self>

Consume this reader to create a decompression stream of this stream.
source§

fn deflate_encode(self, lvl: Compression) -> DeflateEncoder<Self>

Consume this reader to create a compression stream at the specified compression level.
source§

fn deflate_decode(self) -> DeflateDecoder<Self>

Consume this reader to create a decompression stream of this stream.
source§

impl<T> FlateWriteExt for Twhere T: Write,

source§

fn gz_encode(self, lvl: Compression) -> GzEncoder<Self>

Consume this writer to create a compression stream at the specified compression level.
source§

fn zlib_encode(self, lvl: Compression) -> ZlibEncoder<Self>

Consume this writer to create a compression stream at the specified compression level.
source§

fn zlib_decode(self) -> ZlibDecoder<Self>

Consume this writer to create a decompression stream of this stream.
source§

fn deflate_encode(self, lvl: Compression) -> DeflateEncoder<Self>

Consume this writer to create a compression stream at the specified compression level.
source§

fn deflate_decode(self) -> DeflateDecoder<Self>

Consume this writer to create a decompression stream of this stream.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.