Struct git_pack::Bundle [−][src]
Expand description
A bundle of pack data and the corresponding pack index
Fields
pack: File
The pack file corresponding to index
index: File
The index file corresponding to pack
Implementations
Initialization
pub fn get_object_by_index<'a>(
&self,
idx: u32,
out: &'a mut Vec<u8>,
cache: &mut impl DecodeEntry
) -> Result<Object<'a>, Error>
pub fn get_object_by_index<'a>(
&self,
idx: u32,
out: &'a mut Vec<u8>,
cache: &mut impl DecodeEntry
) -> Result<Object<'a>, Error>
Special-use function to get an object given an index previously returned from internal_find_pack_index.
Panics
If index
is out of bounds.
Given a pack
data stream, write it along with a generated index into the directory
if Some
or discard all output if None
.
In the latter case, the functionality provided here is more akind of pack data stream validation.
progress
provides detailed progress information which can be discarded with [git_features::progress::Discard
].should_interrupt
is checked regularly and when true, the whole operation will stop.thin_pack_base_object_lookup_fn
If set, we expect to see a thin-pack with objects that reference their base object by object id which is expected to exist in the object database the bundle is contained within.options
further configure how the task is performed.
Note
- the resulting pack may be empty, that is, contains zero objects in some situations. This is a valid reply by a server and should
be accounted for.
- Empty packs always have the same name and not handling this case will result in at most one superfluous pack.
pub fn write_to_directory_eagerly(
pack: impl Read + Send + 'static,
pack_size: Option<u64>,
directory: Option<impl AsRef<Path>>,
progress: impl Progress,
should_interrupt: &'static AtomicBool,
thin_pack_base_object_lookup_fn: Option<Box<dyn for<'a> FnMut(ObjectId, &'a mut Vec<u8>) -> Option<Object<'a>> + Send + 'static>>,
options: Options
) -> Result<Outcome, Error>
pub fn write_to_directory_eagerly(
pack: impl Read + Send + 'static,
pack_size: Option<u64>,
directory: Option<impl AsRef<Path>>,
progress: impl Progress,
should_interrupt: &'static AtomicBool,
thin_pack_base_object_lookup_fn: Option<Box<dyn for<'a> FnMut(ObjectId, &'a mut Vec<u8>) -> Option<Object<'a>> + Send + 'static>>,
options: Options
) -> Result<Outcome, Error>
Equivalent to write_to_directory()
but offloads reading of the pack into its own thread, hence the Send + 'static'
bounds.
Note
As it sends portions of the input to a thread it requires the ’static lifetime for the interrupt flags. This can only be satisfied by a static AtomicBool which is only suitable for programs that only run one of these operations at a time or don’t mind that all of them abort when the flag is set.
pub fn verify_integrity<C, P>(
&self,
verify_mode: Mode,
traversal: Algorithm,
make_pack_lookup_cache: impl Fn() -> C + Send + Sync,
thread_limit: Option<usize>,
progress: Option<P>,
should_interrupt: Arc<AtomicBool>
) -> Result<(ObjectId, Option<Outcome>, Option<P>), Error<Error>> where
P: Progress,
C: DecodeEntry,
pub fn verify_integrity<C, P>(
&self,
verify_mode: Mode,
traversal: Algorithm,
make_pack_lookup_cache: impl Fn() -> C + Send + Sync,
thread_limit: Option<usize>,
progress: Option<P>,
should_interrupt: Arc<AtomicBool>
) -> Result<(ObjectId, Option<Outcome>, Option<P>), Error<Error>> where
P: Progress,
C: DecodeEntry,
Similar to crate::index::File::verify_integrity()
but more convenient to call as the presence of the
pack file is a given.