Struct Buffer

pub struct Buffer { /* private fields */ }

A buffer containing a packed-ref file that is either memory mapped or fully in-memory depending on a cutoff.

The buffer is guaranteed to be sorted as per the packed-ref rules which allows some operations to be more efficient.

Implementations

impl Buffer

packed-refs specific functionality

pub fn iter(&self) -> Result<Iter<'_>, Error>

Return an iterator of references stored in this packed refs buffer, ordered by reference name.

Note

There is no namespace support in packed iterators. It can be emulated using iter_prefixed(…).

pub fn iter_prefixed(&self, prefix: BString) -> Result<Iter<'_>, Error>

Return an iterator yielding only references matching the given prefix, ordered by reference name.

impl Buffer

Initialization

pub fn open( path: PathBuf, use_memory_map_if_larger_than_bytes: u64, ) -> Result<Self, Error>

Open the file at path and map it into memory if the file size is larger than use_memory_map_if_larger_than_bytes.

In order to allow fast lookups and optimizations, the contents of the packed refs must be sorted. If that’s not the case, they will be sorted on the fly with the data being written into a memory buffer.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error>

Open a buffer from bytes, which is the content of a typical packed-refs file.

In order to allow fast lookups and optimizations, the contents of the packed refs must be sorted. If that’s not the case, they will be sorted on the fly.

impl Buffer

packed-refs specific functionality

pub fn try_find<'a, Name, E>( &self, name: Name, ) -> Result<Option<Reference<'_>>, Error>

where Name: TryInto<&'a PartialNameRef, Error = E>, Error: From<E>,

Find a reference with the given name and return it.

Note that it will look it up verbatim and does not deal with namespaces or special prefixes like main-worktree/ or worktrees/<name>/, as this is left to the caller.

pub fn find<'a, Name, E>(&self, name: Name) -> Result<Reference<'_>, Error>

where Name: TryInto<&'a PartialNameRef, Error = E>, Error: From<E>,

Find a reference with the given name and return it.

Trait Implementations

impl AsRef<[u8]> for Buffer

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for Buffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.