Skip to main content

Header

Struct Header 

Source
pub struct Header<'a> {
    pub position: u64,
    pub format: ArchiveFormat,
    pub kind: UstarKind,
    pub declared_size: u64,
    pub effective_size: u64,
    pub mode: Option<u64>,
    pub uid: Option<u64>,
    pub gid: Option<u64>,
    pub mtime: Option<u64>,
    pub uname: &'a [u8],
    pub gname: &'a [u8],
    /* private fields */
}
Expand description

Extracted ordinary-header metadata for one logical archive member.

Unlike HeaderFrame, this type does not retain the lossless physical header block. Its ordinary path and link-path fallbacks borrow reusable storage owned by TarReader.

Fields§

§position: u64

The absolute byte position of the ordinary member header block.

§format: ArchiveFormat

The selected archive family of this member header.

§kind: UstarKind

The member type identified by the header.

§declared_size: u64

The size encoded directly in the member header field.

§effective_size: u64

The size after applying applicable pax size records.

This is also the number of payload bytes exposed through MemberPayload. Member kinds that cannot carry payload are rejected when either their declared or effective size is nonzero.

§mode: Option<u64>

Permission and mode bits decoded from the ordinary header, if present.

Note that pax only defines the semantics of the lower 12 bits of this field. Higher bits may or may not be set, and have no assigned semantics.

This is None only when the field is wholly NUL and the framing policy permits missing numeric metadata.

§uid: Option<u64>

Numeric user identifier from the ordinary header, if present.

This is None only when the field is wholly NUL and the framing policy permits missing numeric metadata.

Applicable pax metadata may override or delete this fallback.

§gid: Option<u64>

Numeric group identifier from the ordinary header, if present.

This is None only when the field is wholly NUL and the framing policy permits missing numeric metadata.

Applicable pax metadata may override or delete this fallback.

§mtime: Option<u64>

Modification time in seconds from the ordinary header, if present.

This is None only when the field is wholly NUL and the framing policy permits missing numeric metadata.

Applicable pax metadata may override or delete this fallback.

§uname: &'a [u8]

User name bytes from the ordinary header, empty if absent or unusable.

Applicable pax metadata may override or delete this fallback.

§gname: &'a [u8]

Group name bytes from the ordinary header, empty if absent or unusable.

Applicable pax metadata may override or delete this fallback.

Trait Implementations§

Source§

impl<'a> Clone for Header<'a>

Source§

fn clone(&self) -> Header<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for Header<'a>

Source§

impl<'a> Debug for Header<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for Header<'a>

Source§

impl<'a> PartialEq for Header<'a>

Source§

fn eq(&self, other: &Header<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'a> StructuralPartialEq for Header<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Header<'a>

§

impl<'a> RefUnwindSafe for Header<'a>

§

impl<'a> Send for Header<'a>

§

impl<'a> Sync for Header<'a>

§

impl<'a> Unpin for Header<'a>

§

impl<'a> UnsafeUnpin for Header<'a>

§

impl<'a> UnwindSafe for Header<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.