Struct libflate::gzip::Encoder

pub struct Encoder<W, E = DefaultLz77Encoder> { /* private fields */ }

GZIP encoder.

Implementations

impl<W> Encoder<W, DefaultLz77Encoder>

where W: Write,

pub fn new(inner: W) -> Result<Self>

Makes a new encoder instance.

Encoded GZIP stream is written to inner.

Examples

#[cfg(feature = "no_std")]
use core2::io::Write;
#[cfg(not(feature = "no_std"))]
use std::io::Write;
use libflate::gzip::Encoder;

let mut encoder = Encoder::new(Vec::new()).unwrap();
encoder.write_all(&b"Hello World!"[..]).unwrap();
encoder.finish().into_result().unwrap();

impl<W, E> Encoder<W, E>

where W: Write, E: Lz77Encode,

pub fn with_options(inner: W, options: EncodeOptions<E>) -> Result<Self>

Makes a new encoder instance with specified options.

Encoded GZIP stream is written to inner.

Examples

#[cfg(feature = "no_std")]
use core2::io::Write;
#[cfg(not(feature = "no_std"))]
use std::io::Write;
use libflate::gzip::{Encoder, EncodeOptions, HeaderBuilder};

let header = HeaderBuilder::new().modification_time(123).finish();
let options = EncodeOptions::new().no_compression().header(header);
let mut encoder = Encoder::with_options(Vec::new(), options).unwrap();
encoder.write_all(&b"Hello World!"[..]).unwrap();

assert_eq!(encoder.finish().into_result().unwrap(),
           &[31, 139, 8, 0, 123, 0, 0, 0, 0, 3, 1, 12, 0, 243, 255, 72, 101, 108, 108,
             111, 32, 87, 111, 114, 108, 100, 33, 163, 28, 41, 28, 12, 0, 0, 0][..]);

pub fn header(&self) -> &Header

Returns the header of the GZIP stream.

Examples

use libflate::gzip::{Encoder, Os};

let encoder = Encoder::new(Vec::new()).unwrap();
assert_eq!(encoder.header().os(), Os::Unix);

pub fn finish(self) -> Finish<W, Error>

Writes the GZIP trailer and returns the inner stream.

Examples

#[cfg(feature = "no_std")]
use core2::io::Write;
#[cfg(not(feature = "no_std"))]
use std::io::Write;
use libflate::gzip::Encoder;

let mut encoder = Encoder::new(Vec::new()).unwrap();
encoder.write_all(&b"Hello World!"[..]).unwrap();

assert!(encoder.finish().as_result().is_ok())

Note

If you are not concerned the result of this encoding, it may be convenient to use AutoFinishUnchecked instead of the explicit invocation of this method.

#[cfg(feature = "no_std")]
use core2::io::Write;
#[cfg(not(feature = "no_std"))]
use std::io;
use libflate::finish::AutoFinishUnchecked;
use libflate::gzip::Encoder;

let plain = b"Hello World!";
let mut buf = Vec::new();
let mut encoder = AutoFinishUnchecked::new(Encoder::new(&mut buf).unwrap());
#[cfg(feature = "no_std")]
encoder.write_all(plain.as_ref()).unwrap();
#[cfg(not(feature = "no_std"))]
io::copy(&mut &plain[..], &mut encoder).unwrap();

pub fn as_inner_ref(&self) -> &W

Returns the immutable reference to the inner stream.

pub fn as_inner_mut(&mut self) -> &mut W

Returns the mutable reference to the inner stream.

pub fn into_inner(self) -> W

Unwraps the Encoder, returning the inner stream.

Trait Implementations

impl<W, E> Complete for Encoder<W, E>

where W: Write, E: Lz77Encode,

fn complete(self) -> Result<()>

Completes the current processing and returns the result.

impl<W, E> Write for Encoder<W, E>

where W: Write, E: Lz77Encode,

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

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

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

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

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

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

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.

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

Attempts to write an entire buffer into this writer.

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.

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

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

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

where Self: Sized,

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