Struct HeaderBuilder

Source

pub struct HeaderBuilder { /* private fields */ }

Expand description

GZIP header builder.

Implementations§

Source §

impl HeaderBuilder

Source

pub fn new() -> Self

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);

Source

pub fn modification_time(&mut self, modification_time: u32) -> &mut Self

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);

Source

pub fn os(&mut self, os: Os) -> &mut Self

Sets the OS type.

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

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

Source

pub fn text(&mut self) -> &mut Self

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);

Source

pub fn verify(&mut self) -> &mut Self

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);

Source

pub fn extra_field(&mut self, extra: ExtraField) -> &mut Self

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));

Source

pub fn filename(&mut self, filename: CString) -> &mut Self

Sets the file name.

§Examples

#[cfg(not(feature = "std"))]
extern crate alloc;
#[cfg(not(feature = "std"))]
use alloc::ffi::CString;
#[cfg(feature = "std")]
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()));

Source

pub fn comment(&mut self, comment: CString) -> &mut Self

Sets the comment.

§Examples

#[cfg(not(feature = "std"))]
extern crate alloc;
#[cfg(not(feature = "std"))]
use alloc::ffi::CString;
#[cfg(feature = "std")]
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()));