Skip to main content

FileHeader

Struct FileHeader 

Source
pub struct FileHeader {
    pub format_version: u16,
    pub manifest_offset: u64,
    pub cas_offset: u64,
}
Expand description

The 24-byte header at the start of a baked monolithic .pvdb file.

OffsetSizeField
04MAGIC_BYTES
42format_version
62flags (reserved)
88manifest_offset
168cas_offset

Fields§

§format_version: u16

On-disk format version of this file (see FORMAT_VERSION).

§manifest_offset: u64

Absolute byte offset of the manifest (catalog) block.

§cas_offset: u64

Absolute byte offset of the CAS blob pool.

Implementations§

Source§

impl FileHeader

Source

pub const ENCODED_LEN: usize = FILE_HEADER_SIZE

Serialized length, in bytes.

Source

pub const fn new(manifest_offset: u64, cas_offset: u64) -> Self

Construct a header from its two offsets, stamped with the current FORMAT_VERSION.

Source

pub const fn new_versioned( manifest_offset: u64, cas_offset: u64, format_version: u16, ) -> Self

Construct a header stamped with an explicit format_version, so a baker can write the lowest version a file actually needs (see FORMAT_VERSION_BASE).

Source

pub fn encode(&self) -> [u8; 24]

Encode to the fixed 24-byte little-endian wire form, including the magic bytes and format version. The two flag bytes are reserved and written as zero.

Source

pub fn decode(buf: &[u8]) -> Result<Self>

Decode and validate the magic signature and format version.

Returns PvError::SignatureMismatch if the leading bytes are not MAGIC_BYTES, or PvError::Corruption if the file’s format version is zero or newer than this build can read (FORMAT_VERSION). Rejecting an unknown version is what stops a future on-disk change from being silently mis-parsed by an older reader.

Trait Implementations§

Source§

impl Clone for FileHeader

Source§

fn clone(&self) -> Self

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 Copy for FileHeader

Source§

impl Debug for FileHeader

Source§

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

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

impl Eq for FileHeader

Source§

impl PartialEq for FileHeader

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FileHeader

Auto Trait Implementations§

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> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.