Struct FileDataSequenceHeader 

#[repr(C)]
pub struct FileDataSequenceHeader {
    pub file_hash: MerkleHash,
    pub file_flags: u32,
    pub num_entries: u32,
    pub _unused: u64,
}

Each file consists of a FileDataSequenceHeader following a sequence of FileDataSequenceEntry, maybe a sequence of FileVerificationEntry, and maybe a FileMetadataExt determined by file flags.

Fields

file_hash: MerkleHash

file_flags: u32

num_entries: u32

_unused: u64

Implementations

impl FileDataSequenceHeader

pub fn new<I: TryInto<u32>>( file_hash: MerkleHash, num_entries: I, contains_verification: bool, contains_metadata_ext: bool, ) -> Self

where <I as TryInto<u32>>::Error: Debug,

pub fn bookend() -> Self

pub fn is_bookend(&self) -> bool

pub fn serialize<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

pub fn deserialize<R: Read>(reader: &mut R) -> Result<Self, Error>

pub fn contains_metadata_ext(&self) -> bool

pub fn contains_verification(&self) -> bool

pub fn num_info_entry_following(&self) -> u32

Get the number of info entries following the header in this shard, this includes “FileDataSequenceEntry“s, “FileVerificationEntry“s, and “FileMetadataExt”.

pub fn verify_same_file(header1: &Self, header2: &Self)

Verifies that the two headers correspond to the same file. Checks that the file hashes are the same and that the number of entries are the same.

pub fn compare_flag_superset(header_a: &Self, header_b: &Self) -> SupersetResult

Compares the flags of headers A and B to determine if either bitmap is a superset of the other. Can return 4 possible responses:

1. SuperA if A is a superset of B (e.g. A has validation and B has nothing)
2. SuperB if B is a superset of A (e.g. B has metadata_ext and A has nothing)
3. Neither if neither A nor B are supersets of each other (e.g. A has only validation, and B has only metadata_ext)
4. Equal if both A and B have the same flags set.

Trait Implementations

impl Clone for FileDataSequenceHeader

fn clone(&self) -> FileDataSequenceHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileDataSequenceHeader

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

Formats the value using the given formatter.

impl Default for FileDataSequenceHeader

fn default() -> FileDataSequenceHeader

Returns the “default value” for a type.

impl PartialEq for FileDataSequenceHeader

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for FileDataSequenceHeader

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileDataSequenceHeader