Struct VolumeSet 

pub struct VolumeSet {

    pub v: u16,
    pub set_id: ByteBuf,
    pub archive_name: String,
    pub archive_size: u64,
    pub archive_b3: ByteBuf,
    pub piece_size: u32,
    pub data: u16,
    pub parity: u16,
    pub pieces: u32,
    pub stripes: u32,
    pub piece_hashes: Vec<ByteBuf>,
    pub parity_hashes: Vec<ByteBuf>,
    pub root: ByteBuf,
    pub generator: String,
}

The descriptor stored (identically) in every volume of a set.

Fields

v: u16

set_id: ByteBuf

archive_name: String

archive_size: u64

archive_b3: ByteBuf

BLAKE3 of the whole archive file: join verifies the rebuilt file against it.

piece_size: u32

data: u16

parity: u16

pieces: u32

Number of real data pieces (ceil(archive_size / piece_size)).

stripes: u32

ceil(pieces / data).

piece_hashes: Vec<ByteBuf>

parity_hashes: Vec<ByteBuf>

stripes * parity hashes, index stripe * parity + j.

root: ByteBuf

Merkle root over the data piece hashes.

generator: String

Implementations

impl VolumeSet

pub fn total(&self) -> usize

pub fn is_parity(&self, index: usize) -> bool

pub fn volume_pieces(&self, index: usize) -> u64

Number of pieces stored on volume index.

pub fn payload_len(&self, index: usize) -> u64

pub fn volume_name(&self, index: usize) -> String

File name of volume index (1-based in the name, data volumes first). The archive name comes from the descriptor, which may have arrived from another machine: it is used only when it is a safe single path component (no separators, colons, control characters, reserved device names or trailing dots/spaces); otherwise the set id names the files.

pub fn validate(&self) -> Result<()>

Trait Implementations

impl Clone for VolumeSet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VolumeSet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VolumeSet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for VolumeSet

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

where __S: Serializer,

Serialize this value into the given Serde serializer.