Struct gzip_header::GzHeader

pub struct GzHeader { /* fields omitted */ }

A structure representing the raw header of a gzip stream.

The header can contain metadata about the file that was compressed, if present.

Methods

impl GzHeader

pub fn filename(&self) -> Option<&[u8]>

Returns the filename field of this gzip header, if present.

The filename field the gzip header is supposed to be stored using ISO 8859-1 (LATIN-1) encoding and be zero-terminated if following the specification.

pub fn extra(&self) -> Option<&[u8]>

Returns the extra field of this gzip header, if present.

pub fn comment(&self) -> Option<&[u8]>

Returns the comment field of this gzip stream's header, if present.

The comment field in the gzip header is supposed to be stored using ISO 8859-1 (LATIN-1) encoding and be zero-terminated if following the specification.

pub fn mtime(&self) -> u32

Returns the mtime field of this gzip header.

This gives the most recent modification time of the contained file, or alternatively the timestamp of when the file was compressed if the data did not come from a file, or a timestamp was not available when compressing. The time is specified the Unix format, that is: seconds since 00:00:00 GMT, Jan. 1, 1970. (Not that this may cause problems for MS-DOS and other systems that use local rather than Universal time.) An mtime value of 0 means that the timestamp is not set.

pub fn mtime_as_datetime(&self) -> Option<SystemTime>

Returns the mtime field of this gzip header as a SystemTime if present.

Returns None if the mtime is not set, i.e 0. See mtime for more detail.

pub fn os(&self) -> u8

Returns the os field of this gzip stream's header.

pub fn xfl(&self) -> u8

Returns the xfl field of this gzip stream's header.

Trait Implementations

impl Eq for GzHeader

impl PartialEq<GzHeader> for GzHeader

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

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

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

This method tests for !=.

impl Clone for GzHeader

fn clone(&self) -> GzHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GzHeader

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

Formats the value using the given formatter.

impl Display for GzHeader

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

Crudely display the contents of the header

Note that filename/commend are required to be ISO 8859-1 (LATIN-1) encoded by the spec, however to avoid dragging in dependencies we simply interpret them as UTF-8. This may result in garbled output if the names contain special characters.

impl Hash for GzHeader

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].