GitoxideLabs/gitoxide git-ref-v0.10.0

git-ref v0.10.0

on GitHub

With this release, file::Store is easier to use due to thread-safe handling of an internal and shared
packed-buffer instance. An API for passing it as parameter like before is still present, allowing to use
a 'frozen' version of the packed buffer for any amount of operations.

New Features

• Add file::Store::iter_(prefixed_)packed().

  These methods allow using an own packed buffer, usually obtained through
  cached_packed_buffer().

• add file::Store::cached_packed_buffer() for packed refs snapshots

• add file::Store::try_find_packed(…, packed_buffer)
  That way, abstractions can still be built that have other ways of
  managing the packed-refs buffer, allowing it to stay more persistent.

Changed (BREAKING)

• rename file::Store::packed_buffer() to …::open_packed_buffer()
  This makes much clearer what it actually does, as previously it might
  have been a stored packed buffer as well.

• file::Store::from(PathBuf) removed
  At this low level, it's important to be clear about RefLogs and rather
  force the caller to specify the ref-log mode. Technically it depends
  on a few factors, git-repository deals with them, but certainly
  shouldn't default to anything without being clear.

• Reference log line access
  Reference::log_iter(…) now is a platform instead of a forward iterator,
  which requires a call to .all() to return the forward iterator like
  previously.

  Reference::log_iter_rev(…) was removed in favor of
  Reference::log_iter(…).rev().

• file::Store::iter() is now a platform, with .all() and .prefixed(…) respectively
  This way, it's possible to keep shared ownership of the packed buffer
  while allowing the exact same iterator machinery to work as before.

• file::ReferenceExt::follow(…) now without packed refs parameter

• file::ReferenceExt::peel_to_id_in_place(…) now without packed-refs buffer
  It is instead read from the internally synchronized buffer, shared
  across all instances.

• file::Store::(try_)find(…, packed) was removed
  The packed buffer is now handled internally while loading it on demand.
  When compiled with git-features/parallel the file::Store remains
  send and sync.

  The packed refs buffer is shared across clones and it's recommended
  to clone one file::Store instance per thread, each of which can
  use its own namespace.

• move git_ref::file::WriteRefLog to git_ref::store::WriteRefLog

other (BREAKING)

• Reference::logs() -> Reference::log_iter()
  The latter now returns a standard Platform to iterate over all
  reflog entries from oldest to newest or vice versa.

refactor (BREAKING)

• file::Store::base is now file::Store::base() and read-only
  That way, file databases can't be repositioned anymore, it's recommended
  to recreate it if that's desired.

Commit Statistics

• 34 commits contributed to the release over the course of 11 calendar days.
• 13 commits where understood as conventional.
• 2 unique issues were worked on: #259, #263

Thanks Clippy

Clippy helped 1 time to make code idiomatic.

Commit Details