pub struct HeaderBuilder {
    header: Header,
}
Expand description

GZIP header builder.

Fields

header: Header

Implementations

Makes a new builder instance.

Examples
use libflate::gzip::{HeaderBuilder, CompressionLevel, Os};

let header = HeaderBuilder::new().finish();
assert_eq!(header.compression_level(), CompressionLevel::Unknown);
assert_eq!(header.os(), Os::Unix);
assert_eq!(header.is_text(), false);
assert_eq!(header.is_verified(), false);
assert_eq!(header.extra_field(), None);
assert_eq!(header.filename(), None);
assert_eq!(header.comment(), None);

Sets the modification time (UNIX timestamp).

Examples
use libflate::gzip::HeaderBuilder;

let header = HeaderBuilder::new().modification_time(10).finish();
assert_eq!(header.modification_time(), 10);

Sets the OS type.

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

let header = HeaderBuilder::new().os(Os::Ntfs).finish();
assert_eq!(header.os(), Os::Ntfs);

Indicates the encoding data is a ASCII text.

Examples
use libflate::gzip::HeaderBuilder;

let header = HeaderBuilder::new().text().finish();
assert_eq!(header.is_text(), true);

Specifies toe verify header bytes using CRC-16.

Examples
use libflate::gzip::HeaderBuilder;

let header = HeaderBuilder::new().verify().finish();
assert_eq!(header.is_verified(), true);

Sets the extra field.

Examples
use libflate::gzip::{HeaderBuilder, ExtraField, ExtraSubField};

let subfield = ExtraSubField{id: [0, 1], data: vec![2, 3, 4]};
let extra = ExtraField{subfields: vec![subfield]};
let header = HeaderBuilder::new().extra_field(extra.clone()).finish();
assert_eq!(header.extra_field(), Some(&extra));

Sets the file name.

Examples
use std::ffi::CString;
use libflate::gzip::HeaderBuilder;

let header = HeaderBuilder::new().filename(CString::new("foo").unwrap()).finish();
assert_eq!(header.filename(), Some(&CString::new("foo").unwrap()));

Sets the comment.

Examples
use std::ffi::CString;
use libflate::gzip::HeaderBuilder;

let header = HeaderBuilder::new().comment(CString::new("foo").unwrap()).finish();
assert_eq!(header.comment(), Some(&CString::new("foo").unwrap()));

Returns the result header.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.