[−][src]Struct git_odb::pack::index::File
A representation of a pack index file
Implementations
impl File[src]
Instantiation
pub fn at(path: impl AsRef<Path>) -> Result<File, Error>[src]
Open the pack index file at the given path.
impl File[src]
Iteration and access
pub fn oid_at_index(&self, index: u32) -> Id<'_>[src]
Returns 20 bytes sha1 at the given index in our list of (sorted) sha1 hashes. The index ranges from 0 to self.num_objects()
Panics
If index is out of bounds.
pub fn pack_offset_at_index(&self, index: u32) -> u64[src]
Returns the offset into our pack data file at which to start reading the object at index.
Panics
If index is out of bounds.
pub fn crc32_at_index(&self, index: u32) -> Option<u32>[src]
Returns the CRC32 of the object at the given index.
Note: These are always present for index version 2 or higher.
Panics
If index is out of bounds.
pub fn lookup(&self, id: Id<'_>) -> Option<u32>[src]
Returns the index of the given SHA1 for use with the oid_at_index(),
pack_offset_at_index() or crc32_at_index().
pub fn iter<'a>(&'a self) -> Box<dyn Iterator<Item = Entry> + 'a>[src]
An iterator over all Entries of this index file.
pub fn sorted_offsets(&self) -> Vec<u64>[src]
Return a vector of ascending offsets into our respective pack data file.
Useful to control an iteration over all pack entries in a cache-friendly way.
impl File[src]
Traversal with index
pub fn traverse_with_index<P, Processor, E>(
&self,
check: SafetyCheck,
thread_limit: Option<usize>,
new_processor: impl Fn() -> Processor + Send + Sync,
root: P,
pack: &File
) -> Result<(Id, Outcome, P), Error<E>> where
P: Progress,
Processor: FnMut(Kind, &[u8], &Entry, &mut <<P as Progress>::SubProgress as Progress>::SubProgress) -> Result<(), E>,
E: Error + Send + Sync + 'static, [src]
&self,
check: SafetyCheck,
thread_limit: Option<usize>,
new_processor: impl Fn() -> Processor + Send + Sync,
root: P,
pack: &File
) -> Result<(Id, Outcome, P), Error<E>> where
P: Progress,
Processor: FnMut(Kind, &[u8], &Entry, &mut <<P as Progress>::SubProgress as Progress>::SubProgress) -> Result<(), E>,
E: Error + Send + Sync + 'static,
Iterate through all decoded objects in the given pack and handle them with a Processor, using an index to reduce waste
at the cost of memory.
For more details, see the documentation on the traverse() method.
impl File[src]
Verify and validate the content of the index file
pub fn traverse_with_lookup<P, C, Processor, E>(
&self,
check: SafetyCheck,
thread_limit: Option<usize>,
new_processor: impl Fn() -> Processor + Send + Sync,
new_cache: impl Fn() -> C + Send + Sync,
root: P,
pack: &File
) -> Result<(Id, Outcome, P), Error<E>> where
P: Progress,
C: DecodeEntry,
E: Error + Send + Sync + 'static,
Processor: FnMut(Kind, &[u8], &Entry, &mut <<P as Progress>::SubProgress as Progress>::SubProgress) -> Result<(), E>, [src]
&self,
check: SafetyCheck,
thread_limit: Option<usize>,
new_processor: impl Fn() -> Processor + Send + Sync,
new_cache: impl Fn() -> C + Send + Sync,
root: P,
pack: &File
) -> Result<(Id, Outcome, P), Error<E>> where
P: Progress,
C: DecodeEntry,
E: Error + Send + Sync + 'static,
Processor: FnMut(Kind, &[u8], &Entry, &mut <<P as Progress>::SubProgress as Progress>::SubProgress) -> Result<(), E>,
Iterate through all decoded objects in the given pack and handle them with a Processor using a cache to reduce the amount of
waste while decoding objects.
For more details, see the documentation on the traverse() method.
impl File[src]
Traversal of pack data files using an index file
pub fn traverse<P, C, Processor, E>(
&self,
pack: &File,
progress: Option<P>,
new_processor: impl Fn() -> Processor + Send + Sync,
new_cache: impl Fn() -> C + Send + Sync,
Options { algorithm: algorithm, thread_limit: thread_limit, check: check }: Options
) -> Result<(Id, Outcome, Option<P>), Error<E>> where
P: Progress,
C: DecodeEntry,
E: Error + Send + Sync + 'static,
Processor: FnMut(Kind, &[u8], &Entry, &mut DoOrDiscard<<<P as Progress>::SubProgress as Progress>::SubProgress>) -> Result<(), E>, [src]
&self,
pack: &File,
progress: Option<P>,
new_processor: impl Fn() -> Processor + Send + Sync,
new_cache: impl Fn() -> C + Send + Sync,
Options { algorithm: algorithm, thread_limit: thread_limit, check: check }: Options
) -> Result<(Id, Outcome, Option<P>), Error<E>> where
P: Progress,
C: DecodeEntry,
E: Error + Send + Sync + 'static,
Processor: FnMut(Kind, &[u8], &Entry, &mut DoOrDiscard<<<P as Progress>::SubProgress as Progress>::SubProgress>) -> Result<(), E>,
Iterate through all decoded objects in the given pack and handle them with a Processor.
The return value is (pack-checksum, Outcome, progress), thus the pack traversal will always verify
the whole packs checksum to assure it was correct. In case of bit-rod, the operation will abort early without
verifying all objects using the interrupt mechanism mechanism.
Algorithms
Using the Options::algorithm field one can chose between two algorithms providing different tradeoffs. Both invoke
new_processor() to create functions receiving decoded objects, their object kind, index entry and a progress instance to provide
progress information.
Algorithm::DeltaTreeLookupbuilds an index to avoid any unnecessary computation while resolving objects, avoiding the need for a cache entirely, renderingnew_cache()unused. One could also calltraverse_with_index()directly.Algorithm::Lookupuses a cache created bynew_cache()to avoid having to re-compute all bases of a delta-chain while decoding objects. One could also calltraverse_with_lookup()directly.
Use thread_limit to further control parallelism and check to define how much the passed
objects shall be verified beforehand.
impl File[src]
Verify and validate the content of the index file
pub fn index_checksum(&self) -> Id[src]
Returns the trailing hash stored at the end of this index file.
It's a hash over all bytes of the index.
pub fn pack_checksum(&self) -> Id[src]
Returns the hash of the pack data file that this index file corresponds to.
It should pack::data::File::checksum() of the corresponding pack data file.
pub fn verify_checksum(&self, progress: impl Progress) -> Result<Id, Error>[src]
Validate that our index_checksum() matches the actual contents
of this index file, and return it if it does.
pub fn verify_integrity<C, P>(
&self,
pack: Option<(&File, Mode, Algorithm, impl Fn() -> C + Send + Sync)>,
thread_limit: Option<usize>,
progress: Option<P>
) -> Result<(Id, Option<Outcome>, Option<P>), Error<Error>> where
P: Progress,
C: DecodeEntry, [src]
&self,
pack: Option<(&File, Mode, Algorithm, impl Fn() -> C + Send + Sync)>,
thread_limit: Option<usize>,
progress: Option<P>
) -> Result<(Id, Option<Outcome>, Option<P>), Error<Error>> where
P: Progress,
C: DecodeEntry,
The most thorough validation of integrity of both index file and the corresponding pack data file, if provided. Returns the checksum of the index file, the traversal outcome and the given progress if the integrity check is successful.
If pack is provided, it is expected (and validated to be) the pack belonging to this index.
It will be used to validate internal integrity of the pack before checking each objects integrity
is indeed as advertised via its SHA1 as stored in this index, as well as the CRC32 hash.
The last member of the Option is a function returning an implementation of pack::cache::DecodeEntry to be used if
the index::traverse::Algorithm is Lookup.
To set this to None, use None::<(_, _, _, fn() -> pack::cache::Noop)>.
The thread_limit optionally specifies the amount of threads to be used for the pack traversal.
make_cache is only used in case a pack is specified, use existing implementations in the pack::cache module.
Tradeoffs
The given progress is inevitably consumed if there is an error, which is a tradeoff chosen to easily allow using ? in the
error case.
impl File[src]
Various ways of writing an index file from pack entries
pub fn write_data_iter_to_stream<F, F2>(
kind: Version,
make_resolver: F,
entries: impl Iterator<Item = Result<Entry, Error>>,
thread_limit: Option<usize>,
root_progress: impl Progress,
out: impl Write
) -> Result<Outcome, Error> where
F: FnOnce() -> Result<F2>,
F2: for<'r> Fn(EntrySlice, &'r mut Vec<u8>) -> Option<()> + Send + Sync, [src]
kind: Version,
make_resolver: F,
entries: impl Iterator<Item = Result<Entry, Error>>,
thread_limit: Option<usize>,
root_progress: impl Progress,
out: impl Write
) -> Result<Outcome, Error> where
F: FnOnce() -> Result<F2>,
F2: for<'r> Fn(EntrySlice, &'r mut Vec<u8>) -> Option<()> + Send + Sync,
Write information about entries as obtained from a pack data file into a pack index file via the out stream.
The resolver produced by make_resolver must resolve pack entries from the same pack data file that produced the
entries iterator.
kind is the version of pack index to produce, use pack::index::Version::default() if in doubt.
tread_limit is used for a parallel tree traversal for obtaining object hashes with optimal performance.
root_progress is the top-level progress to stay informed about the progress of this potentially long-running
computation.
Remarks
- neither in-pack nor out-of-pack Ref Deltas are supported here, these must have been resolved beforehand.
make_resolver()will only be called after the iterator stopped returning elements and produces a function that provides all bytes belonging to a pack entry writing them to the given mutable outputVec. It should returnNoneif the entry cannot be resolved from the pack that produced theentriesiterator, causing the write operation to fail.
impl File[src]
Basic file information
pub fn version(&self) -> Version[src]
The version of the pack index
pub fn path(&self) -> &Path[src]
The path of the opened index file
pub fn num_objects(&self) -> u32[src]
The amount of objects stored in the pack and index
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for File[src]
impl Send for File[src]
impl Sync for File[src]
impl Unpin for File[src]
impl UnwindSafe for File[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> Conv for T
impl<T> Conv for T
impl<T> FmtForward for T
pub fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
Self: Binary,
pub fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
Self: Display,
pub fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
Self: LowerExp,
pub fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
Self: LowerHex,
pub fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,
Self: Octal,
pub fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
Self: Pointer,
pub fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
Self: UpperExp,
pub fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
Self: UpperHex,
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> Pipe for T where
T: ?Sized,
T: ?Sized,
pub fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
pub fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,
R: 'a,
pub fn pipe_ref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self) -> R
) -> R where
R: 'a,
&'a mut self,
func: impl FnOnce(&'a mut Self) -> R
) -> R where
R: 'a,
pub fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
B: 'a + ?Sized,
R: 'a,
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
Self: Borrow<B>,
pub fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
B: 'a + ?Sized,
R: 'a,
Self: BorrowMut<B>,
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
B: 'a + ?Sized,
R: 'a,
Self: BorrowMut<B>,
pub fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
R: 'a,
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
Self: AsRef<U>,
U: 'a + ?Sized,
pub fn pipe_as_mut<'a, U, R>(
&'a mut self,
func: impl FnOnce(&'a mut U) -> R
) -> R where
R: 'a,
Self: AsMut<U>,
U: 'a + ?Sized,
&'a mut self,
func: impl FnOnce(&'a mut U) -> R
) -> R where
R: 'a,
Self: AsMut<U>,
U: 'a + ?Sized,
pub fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
R: 'a,
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
Self: Deref<Target = T>,
T: 'a + ?Sized,
pub fn pipe_deref_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
R: 'a,
Self: DerefMut<Target = T> + Deref,
T: 'a + ?Sized,
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
R: 'a,
Self: DerefMut<Target = T> + Deref,
T: 'a + ?Sized,
impl<T> Pipe for T
impl<T> PipeAsRef for T
pub fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
R: 'a,
Self: AsRef<T>,
T: 'a,
R: 'a,
Self: AsRef<T>,
T: 'a,
pub fn pipe_as_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
R: 'a,
Self: AsMut<T>,
T: 'a,
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
R: 'a,
Self: AsMut<T>,
T: 'a,
impl<T> PipeBorrow for T
pub fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
R: 'a,
Self: Borrow<T>,
T: 'a,
R: 'a,
Self: Borrow<T>,
T: 'a,
pub fn pipe_borrow_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
R: 'a,
Self: BorrowMut<T>,
T: 'a,
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
R: 'a,
Self: BorrowMut<T>,
T: 'a,
impl<T> PipeDeref for T
pub fn pipe_deref<'a, R>(
&'a self,
func: impl FnOnce(&'a Self::Target) -> R
) -> R where
R: 'a,
Self: Deref,
&'a self,
func: impl FnOnce(&'a Self::Target) -> R
) -> R where
R: 'a,
Self: Deref,
pub fn pipe_deref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
R: 'a,
Self: DerefMut,
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
R: 'a,
Self: DerefMut,
impl<T> PipeRef for T
pub fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,
R: 'a,
pub fn pipe_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
R: 'a,
impl<T> Tap for T
pub fn tap(self, func: impl FnOnce(&Self)) -> Self
pub fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self
pub fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
B: ?Sized,
Self: Borrow<B>,
B: ?Sized,
Self: Borrow<B>,
pub fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
B: ?Sized,
Self: BorrowMut<B>,
B: ?Sized,
Self: BorrowMut<B>,
pub fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
R: ?Sized,
Self: AsRef<R>,
R: ?Sized,
Self: AsRef<R>,
pub fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
R: ?Sized,
Self: AsMut<R>,
R: ?Sized,
Self: AsMut<R>,
pub fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,
Self: Deref<Target = T>,
T: ?Sized,
pub fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
pub fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
pub fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
pub fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
B: ?Sized,
Self: Borrow<B>,
B: ?Sized,
Self: Borrow<B>,
pub fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
B: ?Sized,
Self: BorrowMut<B>,
B: ?Sized,
Self: BorrowMut<B>,
pub fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
R: ?Sized,
Self: AsRef<R>,
R: ?Sized,
Self: AsRef<R>,
pub fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
R: ?Sized,
Self: AsMut<R>,
R: ?Sized,
Self: AsMut<R>,
pub fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,
Self: Deref<Target = T>,
T: ?Sized,
pub fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
impl<T> Tap for T
pub fn tap<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,
F: FnOnce(&Self) -> R,
pub fn tap_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,
F: FnOnce(&Self) -> R,
pub fn tap_mut<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,
F: FnOnce(&mut Self) -> R,
pub fn tap_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,
F: FnOnce(&mut Self) -> R,
impl<T, U> TapAsRef<U> for T where
U: ?Sized,
U: ?Sized,
pub fn tap_ref<F, R>(self, func: F) -> Self where
F: FnOnce(&T) -> R,
Self: AsRef<T>,
F: FnOnce(&T) -> R,
Self: AsRef<T>,
pub fn tap_ref_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&T) -> R,
Self: AsRef<T>,
F: FnOnce(&T) -> R,
Self: AsRef<T>,
pub fn tap_ref_mut<F, R>(self, func: F) -> Self where
F: FnOnce(&mut T) -> R,
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
Self: AsMut<T>,
pub fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut T) -> R,
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
Self: AsMut<T>,
impl<T, U> TapBorrow<U> for T where
U: ?Sized,
U: ?Sized,
pub fn tap_borrow<F, R>(self, func: F) -> Self where
F: FnOnce(&T) -> R,
Self: Borrow<T>,
F: FnOnce(&T) -> R,
Self: Borrow<T>,
pub fn tap_borrow_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&T) -> R,
Self: Borrow<T>,
F: FnOnce(&T) -> R,
Self: Borrow<T>,
pub fn tap_borrow_mut<F, R>(self, func: F) -> Self where
F: FnOnce(&mut T) -> R,
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Self: BorrowMut<T>,
pub fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut T) -> R,
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Self: BorrowMut<T>,
impl<T> TapDeref for T
pub fn tap_deref<F, R>(self, func: F) -> Self where
F: FnOnce(&Self::Target) -> R,
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Self: Deref,
pub fn tap_deref_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&Self::Target) -> R,
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Self: Deref,
pub fn tap_deref_mut<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self::Target) -> R,
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Self: DerefMut,
pub fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self::Target) -> R,
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Self: DerefMut,
impl<T> TryConv for T
impl<T> TryConv for T
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,