Struct gzip_header::GzBuilder

pub struct GzBuilder { /* fields omitted */ }

A builder structure to create a new gzip header.

This structure controls header configuration options such as the filename.

Methods

impl GzBuilder

pub fn new() -> GzBuilder

Create a new blank builder with no header by default.

pub fn mtime(self, mtime: u32) -> GzBuilder

Configure the mtime field in the gzip header.

pub fn extra<T: Into<Vec<u8>>>(self, extra: T) -> GzBuilder

Configure the extra field in the gzip header.

pub fn filename<T: Into<Vec<u8>>>(self, filename: T) -> GzBuilder

Configure the filename field in the gzip header.

Panics

Panics if the filename argument contains a byte with the value 0.

pub fn comment<T: Into<Vec<u8>>>(self, comment: T) -> GzBuilder

Configure the comment field in the gzip header.

Panics

Panics if the comment argument contains a byte with the value 0.

pub fn os(self, os: FileSystemType) -> GzBuilder

Configure the os field in the gzip header.

This is taken from std::env::consts::OS if not set explicitly.

pub fn xfl(self, xfl: ExtraFlags) -> GzBuilder

Configure the xfl field in the gzip header.

The default is ExtraFlags::Default (meaning not set).

pub fn into_header_xfl(self, lvl: ExtraFlags) -> Vec<u8>

Transforms this builder structure into a raw vector of bytes, setting the XFL field to the value specified by lvl.

pub fn into_header(self) -> Vec<u8>

Transforms this builder structure into a raw vector of bytes.

pub fn into_header_with_checksum(self) -> Vec<u8>

Transforms this builder structure into a raw vector of bytes.

Trait Implementations

impl Eq for GzBuilder

impl Clone for GzBuilder

fn clone(&self) -> GzBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq<GzBuilder> for GzBuilder

fn eq(&self, other: &GzBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GzBuilder) -> bool

This method tests for !=.

impl Default for GzBuilder

fn default() -> GzBuilder

Returns the "default value" for a type.

impl Debug for GzBuilder

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

Formats the value using the given formatter.