Struct flate2::GzHeader

[+] Show declaration

pub struct GzHeader { /* fields omitted */ }

[−] Expand description

A structure representing the 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 stream's header, if present.

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

[−]

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

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

[−]

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

pub fn operating_system(&self) -> u8

[−]

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

There are predefined values for various operating systems. 255 means that the value is unknown.

pub fn mtime(&self) -> u32

[−]

This gives the most recent modification time of the original file being compressed.

The time is in Unix format, i.e., seconds since 00:00:00 GMT, Jan. 1, 1970. (Note that this may cause problems for MS-DOS and other systems that use local rather than Universal time.) If the compressed data did not come from a file, mtime is set to the time at which compression started. mtime = 0 means no time stamp is available.

The usage of mtime is discouraged because of Year 2038 problem.

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

[−]

Returns the most recent modification time represented by a date-time type. Returns None if the value of the underlying counter is 0, indicating no time stamp is available.

The time is measured as seconds since 00:00:00 GMT, Jan. 1 1970. See mtime for more detail.

Trait Implementations

impl PartialEq 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.