Struct flate2::GzBuilder [−][src]
A builder structure to create a new gzip Encoder.
This structure controls header configuration options such as the filename.
Examples
use std::io::prelude::*; use std::fs::File; use flate2::GzBuilder; use flate2::Compression; // GzBuilder opens a file and writes a sample string using GzBuilder pattern let f = File::create("examples/hello_world.gz")?; let mut gz = GzBuilder::new() .filename("hello_world.txt") .comment("test file, please delete") .write(f, Compression::default()); gz.write_all(b"hello world")?; gz.finish()?;
Implementations
impl GzBuilder
[src]
pub fn new() -> GzBuilder
[src]
Create a new blank builder with no header by default.
pub fn mtime(self, mtime: u32) -> GzBuilder
[src]
Configure the mtime
field in the gzip header.
pub fn operating_system(self, os: u8) -> GzBuilder
[src]
Configure the operating_system
field in the gzip header.
pub fn extra<T: Into<Vec<u8>>>(self, extra: T) -> GzBuilder
[src]
Configure the extra
field in the gzip header.
pub fn filename<T: Into<Vec<u8>>>(self, filename: T) -> GzBuilder
[src]
Configure the filename
field in the gzip header.
Panics
Panics if the filename
slice contains a zero.
pub fn comment<T: Into<Vec<u8>>>(self, comment: T) -> GzBuilder
[src]
pub fn write<W: Write>(self, w: W, lvl: Compression) -> GzEncoder<W>ⓘ
[src]
Consume this builder, creating a writer encoder in the process.
The data written to the returned encoder will be compressed and then
written out to the supplied parameter w
.
pub fn read<R: Read>(self, r: R, lvl: Compression) -> GzEncoder<R>ⓘ
[src]
Consume this builder, creating a reader encoder in the process.
Data read from the returned encoder will be the compressed version of the data read from the given reader.
pub fn buf_read<R>(self, r: R, lvl: Compression) -> GzEncoder<R>ⓘ where
R: BufRead,
[src]
R: BufRead,
Consume this builder, creating a reader encoder in the process.
Data read from the returned encoder will be the compressed version of the data read from the given reader.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for GzBuilder
impl Send for GzBuilder
impl Sync for GzBuilder
impl Unpin for GzBuilder
impl UnwindSafe for GzBuilder
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>,