Struct GnuHeader 

#[repr(C)]
pub struct GnuHeader {

    pub name: [u8; 100],
    pub mode: [u8; 8],
    pub uid: [u8; 8],
    pub gid: [u8; 8],
    pub size: [u8; 12],
    pub mtime: [u8; 12],
    pub cksum: [u8; 8],
    pub typeflag: [u8; 1],
    pub linkname: [u8; 100],
    pub magic: [u8; 6],
    pub version: [u8; 2],
    pub uname: [u8; 32],
    pub gname: [u8; 32],
    pub dev_major: [u8; 8],
    pub dev_minor: [u8; 8],
    pub atime: [u8; 12],
    pub ctime: [u8; 12],
    pub offset: [u8; 12],
    pub longnames: [u8; 4],
    pub unused: [u8; 1],
    pub sparse: [GnuSparseHeader; 4],
    pub isextended: [u8; 1],
    pub realsize: [u8; 12],
    pub pad: [u8; 17],
}

GNU tar header format with sparse file support.

This format extends UStar with support for sparse files, access/creation times, and long name handling. The prefix field is replaced with additional metadata. See module-level documentation for the field layout table.

Fields

name: [u8; 100]

File path name (null-terminated if shorter than 100 bytes).

mode: [u8; 8]

File mode in octal ASCII.

uid: [u8; 8]

Owner user ID in octal ASCII.

gid: [u8; 8]

Owner group ID in octal ASCII.

size: [u8; 12]

File size in octal ASCII (for sparse files, this is the size on disk).

mtime: [u8; 12]

Modification time as Unix timestamp in octal ASCII.

cksum: [u8; 8]

Header checksum in octal ASCII.

typeflag: [u8; 1]

Entry type flag.

linkname: [u8; 100]

Link target name for hard/symbolic links.

magic: [u8; 6]

Magic string identifying the format (“ustar “ for GNU).

version: [u8; 2]

Format version (“ \0“ for GNU).

uname: [u8; 32]

Owner user name (null-terminated).

gname: [u8; 32]

Owner group name (null-terminated).

dev_major: [u8; 8]

Device major number in octal ASCII (for special files).

dev_minor: [u8; 8]

Device minor number in octal ASCII (for special files).

atime: [u8; 12]

Access time in octal ASCII.

ctime: [u8; 12]

Creation time in octal ASCII.

offset: [u8; 12]

Offset for multivolume archives.

longnames: [u8; 4]

Long names support (deprecated).

unused: [u8; 1]

Unused padding byte.

sparse: [GnuSparseHeader; 4]

Sparse file chunk descriptors (4 entries).

isextended: [u8; 1]

Flag indicating more sparse headers follow.

realsize: [u8; 12]

Real size of sparse file (uncompressed).

pad: [u8; 17]

Padding to fill the 512-byte block.

Implementations

impl GnuHeader

pub fn atime(&self) -> Result<u64>

Get the access time in Unix timestamp format.

Errors

Returns HeaderError::InvalidOctal if the atime field is not valid.

pub fn set_atime(&mut self, atime: u64)

Set the access time as a Unix timestamp.

Uses octal ASCII if the value fits, otherwise GNU base-256 encoding. The 12-byte atime field can represent any u64.

pub fn ctime(&self) -> Result<u64>

Get the change time in Unix timestamp format.

Errors

Returns HeaderError::InvalidOctal if the ctime field is not valid.

pub fn set_ctime(&mut self, ctime: u64)

Set the change time as a Unix timestamp.

Uses octal ASCII if the value fits, otherwise GNU base-256 encoding. The 12-byte ctime field can represent any u64.

pub fn real_size(&self) -> Result<u64>

Get the “real size” of a sparse file.

For sparse files, this is the size of the entire file after the sparse regions have been filled in. For non-sparse files, this may be zero.

Errors

Returns HeaderError::InvalidOctal if the realsize field is not valid.

pub fn set_real_size(&mut self, size: u64)

Set the “real size” of a sparse file.

Uses octal ASCII if the value fits, otherwise GNU base-256 encoding. The 12-byte realsize field can represent any u64.

pub fn is_extended(&self) -> bool

Returns whether this header will be followed by additional sparse headers.

When true, the next 512-byte block contains a GnuExtSparseHeader.

pub fn set_is_extended(&mut self, extended: bool)

Sets whether this header should be followed by additional sparse headers.

Trait Implementations

impl Clone for GnuHeader

fn clone(&self) -> GnuHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GnuHeader

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

Formats the value using the given formatter.

impl Default for GnuHeader

fn default() -> Self

Returns the “default value” for a type.

impl FromBytes for GnuHeader

where [u8; 100]: FromBytes, [u8; 8]: FromBytes, [u8; 12]: FromBytes, [u8; 1]: FromBytes, [u8; 6]: FromBytes, [u8; 2]: FromBytes, [u8; 32]: FromBytes, [u8; 4]: FromBytes, [GnuSparseHeader; 4]: FromBytes, [u8; 17]: FromBytes,

fn ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

fn ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the prefix of the given source as a &Self without copying.

fn ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: Immutable + KnownLayout,

Interprets the suffix of the given bytes as a &Self.

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the prefix of the given source as a &mut Self without copying.

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the suffix of the given source as a &mut Self without copying.

fn ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &Self with a DST length equal to count.

fn ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the prefix of the given source as a DST &Self with length equal to count.

fn ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the suffix of the given source as a DST &Self with length equal to count.

fn mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &mut Self with a DST length equal to count.

fn mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the prefix of the given source as a &mut Self with DST length equal to count.

fn mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the suffix of the given source as a &mut Self with DST length equal to count.

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

fn read_from_io<R>(src: R) -> Result<Self, Error>

where Self: Sized, R: Read,

Reads a copy of self from an io::Read.

impl FromZeros for GnuHeader

where [u8; 100]: FromZeros, [u8; 8]: FromZeros, [u8; 12]: FromZeros, [u8; 1]: FromZeros, [u8; 6]: FromZeros, [u8; 2]: FromZeros, [u8; 32]: FromZeros, [u8; 4]: FromZeros, [GnuSparseHeader; 4]: FromZeros, [u8; 17]: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

fn new_box_zeroed() -> Result<Box<Self>, AllocError>

where Self: Sized,

Creates a Box<Self> from zeroed bytes.

fn new_box_zeroed_with_elems(count: usize) -> Result<Box<Self>, AllocError>

where Self: KnownLayout<PointerMetadata = usize>,

Creates a Box<[Self]> (a boxed slice) from zeroed bytes.

fn new_vec_zeroed(len: usize) -> Result<Vec<Self>, AllocError>

where Self: Sized,

Creates a Vec<Self> from zeroed bytes.

fn extend_vec_zeroed( v: &mut Vec<Self>, additional: usize, ) -> Result<(), AllocError>

where Self: Sized,

Extends a Vec<Self> by pushing additional new items onto the end of the vector. The new items are initialized with zeros.

fn insert_vec_zeroed( v: &mut Vec<Self>, position: usize, additional: usize, ) -> Result<(), AllocError>

where Self: Sized,

Inserts additional new items into Vec<Self> at position. The new items are initialized with zeros.

impl IntoBytes for GnuHeader

where [u8; 100]: IntoBytes, [u8; 8]: IntoBytes, [u8; 12]: IntoBytes, [u8; 1]: IntoBytes, [u8; 6]: IntoBytes, [u8; 2]: IntoBytes, [u8; 32]: IntoBytes, [u8; 4]: IntoBytes, [GnuSparseHeader; 4]: IntoBytes, [u8; 17]: IntoBytes, (): PaddingFree<Self, { _ }>,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

fn write_to_io<W>(&self, dst: W) -> Result<(), Error>

where Self: Immutable, W: Write,

Writes a copy of self to an io::Write.

impl KnownLayout for GnuHeader

where [u8; 17]: KnownLayout,

type PointerMetadata = <[u8; 17] as KnownLayout>::PointerMetadata

The type of metadata stored in a pointer to Self.

fn size_for_metadata(meta: Self::PointerMetadata) -> Option<usize>

Computes the size of an object of type Self with the given pointer metadata.

impl TryFromBytes for GnuHeader

where [u8; 100]: TryFromBytes, [u8; 8]: TryFromBytes, [u8; 12]: TryFromBytes, [u8; 1]: TryFromBytes, [u8; 6]: TryFromBytes, [u8; 2]: TryFromBytes, [u8; 32]: TryFromBytes, [u8; 4]: TryFromBytes, [GnuSparseHeader; 4]: TryFromBytes, [u8; 17]: TryFromBytes,

fn try_ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the given source as a &Self with a DST length equal to count.

fn try_ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the prefix of the given source as a &Self with a DST length equal to count.

fn try_ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the suffix of the given source as a &Self with a DST length equal to count.

fn try_mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the given source as a &mut Self with a DST length equal to count.

fn try_mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self with a DST length equal to count.

fn try_mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self with a DST length equal to count.

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl Copy for GnuHeader

impl Immutable for GnuHeader

where [u8; 100]: Immutable, [u8; 8]: Immutable, [u8; 12]: Immutable, [u8; 1]: Immutable, [u8; 6]: Immutable, [u8; 2]: Immutable, [u8; 32]: Immutable, [u8; 4]: Immutable, [GnuSparseHeader; 4]: Immutable, [u8; 17]: Immutable,