Struct Indexer

pub struct Indexer<'odb> { /* private fields */ }

A stream to write and index a packfile

This is equivalent to crate::OdbPackwriter, but allows to store the pack and index at an arbitrary path. It also does not require access to an object database if, and only if, the pack file is self-contained (i.e. not “thin”).

Implementations

impl<'a> Indexer<'a>

pub fn new( odb: Option<&Odb<'a>>, path: &Path, mode: u32, verify: bool, ) -> Result<Self, Error>

Create a new indexer

The Odb is used to resolve base objects when fixing thin packs. It can be None if no thin pack is expected, in which case missing bases will result in an error.

path is the directory where the packfile should be stored.

mode is the permissions to use for the output files, use 0 for defaults.

If verify is false, the indexer will bypass object connectivity checks.

pub fn commit(self) -> Result<String, Error>

Finalize the pack and index

Resolves any pending deltas and writes out the index file. The returned string is the hexadecimal checksum of the packfile, which is also used to name the pack and index files (pack-<checksum>.pack and pack-<checksum>.idx respectively).

pub fn progress<F>(&mut self, cb: F) -> &mut Self

where F: FnMut(Progress<'_>) -> bool + 'a,

The callback through which progress is monitored. Be aware that this is called inline, so performance may be affected.

Trait Implementations

impl Drop for Indexer<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Write for Indexer<'_>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.