Struct XorbObjectInfoV1 

pub struct XorbObjectInfoV1 {

    pub ident: XorbObjectIdent,
    pub version: u8,
    pub xorb_hash: MerkleHash,
    pub ident_hash_section: XorbObjectIdent,
    pub hashes_version: u8,
    pub chunk_hashes: Vec<MerkleHash>,
    pub ident_boundary_section: XorbObjectIdent,
    pub boundaries_version: u8,
    pub chunk_boundary_offsets: Vec<u32>,
    pub unpacked_chunk_offsets: Vec<u32>,
    pub num_chunks: u32,
    pub hashes_section_offset_from_end: u32,
    pub boundary_section_offset_from_end: u32,
    /* private fields */
}

Info struct for XorbObject. This is stored at the end of the XORB.

Fields

ident: XorbObjectIdent

XORB identifier: “XETBLOB”

version: u8

Format version, expected to be 1 right now.

xorb_hash: MerkleHash

256-bits, 32-bytes, The XORB Hash of this Xorb.

ident_hash_section: XorbObjectIdent

The hashes section XORB identifier: “XBLBHSH”

hashes_version: u8

The version of the chunk hash section.

chunk_hashes: Vec<MerkleHash>

Total number of chunks in the Xorb. Duplicated here. This only exists in the physical serialized layout. Merklehash for each chunk stored in the Xorb. Length of vector is num_chunks.

ident_boundary_section: XorbObjectIdent

The boundaries and index metadata The identity for the metadata section; should be “XBLBMDT”

boundaries_version: u8

The version of the boundary section.

chunk_boundary_offsets: Vec<u32>

Total number of chunks in the Xorb. Duplicated here. This only exists in the physical serialized layout Byte offset marking the boundary of each chunk in physical layout including chunk header. Length of vector is num_chunks.

This vector only contains boundaries, so assumes the first chunk starts at offset 0. The final entry in vector is the total length of the chunks. See example below. chunk[n] are bytes in [chunk_boundary_offsets[n-1], chunk_boundary_offsets[n])

// ex.             chunks: [  0,   1,   2,   3 ]
// chunk_boundary_offsets: [ 100, 200, 300, 400]

unpacked_chunk_offsets: Vec<u32>

The byte offsets marking the boundary of each chunk in uncompressed layout without header, assuming that each chunk gets unzipped and concatenated. Length of vector is num_chunks. This permits range queries on the contents of the xorb. The uncompressed length of chunk k can be determined by unpacked_chunk_offsets[k] - unpacked_chunk_offsets[k - 1].

num_chunks: u32

Below this everything is fixed; these fields are in exactly the same place.

Total number of chunks in the Xorb. This is also duplicated in the serialization at the start of each section.

hashes_section_offset_from_end: u32

boundary_section_offset_from_end: u32

Implementations

impl XorbObjectInfoV1

pub fn serialized_length(&self) -> usize

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

Serialize XorbObjectInfoV1 to provided Writer.

Assumes caller has set position of Writer to appropriate location for serialization.

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

Construct XorbObjectInfo object from Reader + Seek.

Expects metadata struct is found at end of Reader, written out in struct order.

pub fn deserialize_only_boundaries_section<R: Read + Seek>( reader: &mut R, ) -> Result<(Self, u32), CoreError>

Construct XorbObjectInfo object from Reader + Seek.

Expects metadata struct is found at end of Reader, written out in struct order.

pub async fn deserialize_async_v1<R: AsyncRead + Unpin>( reader: &mut R, ) -> Result<(Self, u32), CoreError>

pub async fn deserialize_async<R: AsyncRead + Unpin>( reader: &mut R, version: u8, ) -> Result<(Self, u32), CoreError>

Construct XorbObjectInfo object from AsyncRead. assumes that the ident and version have already been read and verified.

verifies that the length of the footer data matches the length field at the very end of the buffer

pub fn from_v0(src: XorbObjectInfoV0) -> Self

pub fn from_v0_with_unpacked_chunk_offsets( src: XorbObjectInfoV0, unpacked_chunk_offsets: Vec<u32>, ) -> Self

pub fn fill_in_boundary_offsets(&mut self)

pub fn has_chunk_hashes(&self) -> bool

Trait Implementations

impl Clone for XorbObjectInfoV1

fn clone(&self) -> XorbObjectInfoV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XorbObjectInfoV1

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

Formats the value using the given formatter.

impl Default for XorbObjectInfoV1

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for XorbObjectInfoV1

fn eq(&self, other: &XorbObjectInfoV1) -> 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 XorbObjectInfoV1

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for XorbObjectInfoV1

impl StructuralPartialEq for XorbObjectInfoV1