Struct BundleIndex 

#[non_exhaustive]
pub struct BundleIndex {
    pub schema: Option<String>,
    pub rite_bundle: u32,
    pub kind: BundleKind,
    pub fingerprint: Sha256Digest,
    pub files: Vec<BundleFile>,
}

The index at the root of a bundle.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

schema: Option<String>

URL of the JSON Schema the index was written against (BUNDLE_SCHEMA). Editors read it; a reader ignores it.

rite_bundle: u32

Bundle format version (BUNDLE_FORMAT). A reader refuses a value it does not know.

kind: BundleKind

Whether this is the complete record or a disclosure derived from it, written as kind, with a disclosure’s threshold beside it.

fingerprint: Sha256Digest

Fingerprint of the transcript in the bundle. A convenience for indexing; a verifier recomputes it from the transcript.

files: Vec<BundleFile>

Every file in the bundle other than the index, in a stable order.

Implementations

impl BundleIndex

pub fn complete(fingerprint: Sha256Digest, files: Vec<BundleFile>) -> Self

An index for a complete bundle.

pub fn disclosure( fingerprint: Sha256Digest, threshold: Level, files: Vec<BundleFile>, ) -> Self

An index for a disclosure: every line above threshold is withheld.

Trait Implementations

impl Clone for BundleIndex

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 BundleIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BundleIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BundleIndex

impl PartialEq for BundleIndex

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BundleIndex

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 BundleIndex