Struct BundleManifest 

#[non_exhaustive]
pub struct BundleManifest {
    pub entries: Vec<ManifestEntry>,
    /* private fields */
}

A bundle manifest: the files a bundle publishes (adr/appendix-bundles.md).

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.

entries: Vec<ManifestEntry>

Its files, in manifest order.

Implementations

impl BundleManifest

pub const fn new(hash: [u8; 32], entries: Vec<ManifestEntry>) -> Self

A manifest of entries whose blob has the BLAKE3 hash hash. A pull records hash as the source of each file it writes, so a wrong one makes a later pull of the same entry see its own files as foreign.

pub const fn hash(&self) -> [u8; 32]

The manifest blob’s BLAKE3 hash. A pull records it as the source of each file it writes. Filtering entries keeps it: it names the whole manifest.

pub fn parse(bytes: &[u8]) -> Result<Self>

Parse manifest JSON and check its version.

Errors

NotAManifest when the bytes are not a manifest, or name a version other than 1.

pub fn cached(out_dir: &Path, hash: [u8; 32]) -> Result<Option<Self>>

The manifest blob hash a pull into out_dir cached, or None when none is cached. The cache is self-verifying: bytes that do not hash to hash are an error, as is an unreadable cache file.

Errors

The cached file cannot be read, does not hash to hash, or is not a manifest.

pub fn cache_path(out_dir: &Path, hash: [u8; 32]) -> PathBuf

Where a pull into out_dir caches the manifest blob hash.

Trait Implementations

impl Clone for BundleManifest

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 BundleManifest

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

Formats the value using the given formatter.