Byron/gitoxide git-pack-v0.16.0

git-pack v0.16.0

on GitHub

New Features

• zero-objects check for index and multi-index integrity validation
• support for fan-checking in index and multi-index integrity verification
• introduce type for entry indices within an index or multi-index
  That way it's a littl emore descriptive than a bare u32.
• git_pack::Find::try_find_cached(…, pack_cache)
  With this method it's easier to bypass local caches and control
  the cache oneself entirely.
• A simplified version of the Find trait
  It's meant for the next generation of object db handles which keep a
  local cache of all the details of the actual object database.

Bug Fixes

• support Rust 1.52

• Allow resolution of in-pack ref-deltas
  This finally allows delta tree caches to be used on typical small packs
  returned by GitHub.

• don't try to short-cut detection of large offsets when writing index files
  The code incorrectly assumed that the input is sorted by offsets, with
  the largest offset being last, even though by all means that's not the
  case.

• Avoid the dashmap being cloned for each thread
  Intead, share it by reference, it's sync after all.

  This issue was introduced when switching to a Send + Clone model,
  instead of Send + Sync, to allow thread-local caches in database
  handles of all kinds.

• linked::Store now assures unique IDs across compound stores

Changed (BREAKING)

• Improve method signatures of cache::Tree::*

• cleanup and unify verify_integrity() method signature
  Previously they used many different ways of handling their parameters
  despite all boiling down to calling the same 'index::File::traverse()`
  method.

  This allows for more reuse of Options structs and generally makes
  clearer how these optinos are used.

• index::File::traverse() now returns an Outcome struct instead of tuple of 3 fields

• remove Option<impl Progress> in favor of impl Progress

• multi-index integrity check; use integrity::Outcome for various integrity checks

• remove unnecessary Arc around should_interrupt flag

• remove Sha1 mentions in index::verify::Mode::* variants
  The hash is repository defined and not hard-coded

• introduce index::File::verify_integrity(…, pack: Option<PackContext>, …), replacing tuple
  This allows for more documentation on what input is required there and
  generally makes for an easier to use API.

• rename oid::try_from() to try_from_bytes(), add from_bytes_unchecked()
  This change was done in the name of consistency, as from_bytes() is
  used in many other git-* crates

• Change accessors named hash_kind() to object_hash() for consistency

• consistently use object_hash instead of hash_kind

• data::Entry::from_read() now takes a hash lengths as parameter
  That way ref-deltas can be interepreted without hard-coding SHA1

• data::Entry::from_bytes(…, hash_len) takes new parameter
  The hash-len tells it how to interpret ref-delta objects, which
  store the complete hash of the base object.

  This is now entirely configurable.

• index::File::at() with git_hash::Kind parameter
  It will allow to assume different hashes even in the index file format
  which isn't yet capable of storing this information.

• data::File::at() and Bundle::at() now have hash_kind parameter
  It's used to configure the kind of hash to assume when reading packs and
  indices.

• remove make_object_cache parameter from git_pack::data::output::count::objects()
  It now is an implementation detail of the Find trait.

• move bundle::Location to data::entry::Location
  The latter place best describes its purpose.

• remove pack-cache from Find::try_find(…)
  With the new architecture this can be an implementation detail without
  forcing it to be Sync.

• move git_pack::data::Object to git_object::Data, massively alter git_odb::Find trait
  This will break a lot, but has to happen to prepare these traits for the
  next generation of object databases.

Commit Statistics

• 146 commits contributed to the release over the course of 45 calendar days.
• 55 days passed between releases.
• 33 commits where understood as conventional.
• 6 unique issues were worked on: #260, #266, #279, #287, #293, #67

Thanks Clippy

Clippy helped 8 times to make code idiomatic.

Commit Details