Struct Bundle 

pub struct Bundle { /* private fields */ }

An opened bundle file on disk.

Implementations

impl Bundle

pub fn open(path: impl AsRef<Path>) -> Result<Self, BundleError>

Open path and parse the header, leaving the pack at pack_offset.

Errors

Returns BundleError when the signature or header lines are invalid.

pub fn header(&self) -> &BundleHeader

Parsed header.

pub fn path(&self) -> &Path

Path passed to Self::open.

pub fn pack_object_count(&self) -> Result<u32, BundleError>

Object count from the embedded pack header.

Errors

Returns BundleError::MissingPack when the pack stream is absent or truncated.

pub fn pack_byte_offset(&self) -> u64

Byte offset in Self::path where the PACK stream begins.

pub fn verify( &self, repo: &Repository, ) -> Result<BundleVerifyReport, BundleError>

Check prerequisites against repo and ref connectivity.

Errors

Returns BundleError::ObjectFormatMismatch when hash algorithms disagree.

pub fn unbundle( &self, repo: &Repository, ) -> Result<Vec<UnbundledRef>, BundleError>

Stream the embedded pack into repo’s ODB (does not update refs).

With a files-backed primary the pack is installed under objects/pack/. With a custom OdbBuilder::primary store the pack is read straight from the bundle file and every object is written into that store; no temporary file is created. A filtered (v3 filter) bundle is then not marked as a promisor pack, since there is no pack to mark.

Pack integrity is checked while building the pack index (object hashes and the pack trailer); there is no second full read of the pack after indexing.

Errors

Returns BundleError or ingest failures wrapped as BundleError::Io.

pub fn unbundle_with_progress( &self, repo: &Repository, progress: &mut dyn ProgressSink, cancel: &dyn Cancel, ) -> Result<UnbundleOutcome, BundleError>

Like Self::unbundle, reporting receive and index-pack progress through progress.

Trait Implementations

impl Clone for Bundle

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 Bundle

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

Formats the value using the given formatter.