Struct git_odb::loose::Store

pub struct Store {
    pub path: PathBuf,
}

A database for reading and writing objects to disk, one file per object.

Fields

path: PathBuf

The directory in which objects are stored, containing 256 folders representing the hashes first byte.

Implementations

impl Store

Object lookup

pub fn contains(&self, id: impl AsRef<oid>) -> bool

Returns true if the given id is contained in our repository.

pub fn try_find<'a>(
    &self,
    id: impl AsRef<oid>,
    out: &'a mut Vec<u8>
) -> Result<Option<Object<'a>>, Error>

Return the object identified by the given ObjectId if present in this database, writing its raw data into the given out buffer.

Returns Err if there was an error locating or reading the object. Returns Ok<None> if there was no such object.

impl Store

Iteration and traversal

pub fn iter(&self) -> Iter

Return an iterator over all objects contained in the database.

The Ids returned by the iterator can typically be used in the locate(…) method. Note that the result is not sorted or stable, thus ordering can change between runs.

Notes

Iter is used instead of impl Iterator<…> to allow using this iterator in struct fields, as is currently needed if iterators need to be implemented by hand in the absence of generators.

impl Store

Initialization

pub fn at(objects_directory: impl Into<PathBuf>) -> Store

Initialize the Db with the objects_directory containing the hexadecimal first byte subdirectories, which in turn contain all loose objects.

In a git repository, this would be .git/objects.

Trait Implementations

impl Write for Store

fn write_buf(
    &self,
    kind: Kind,
    from: &[u8],
    hash: Kind
) -> Result<ObjectId, Self::Error>

Write the given buffer in from to disk in one syscall at best.

This will cost at least 4 IO operations.

fn write_stream(
    &self,
    kind: Kind,
    size: u64,
    from: impl Read,
    hash: Kind
) -> Result<ObjectId, Self::Error>

Write the given stream in from to disk with at least one syscall.

This will cost at least 4 IO operations.

type Error = Error

The error type used for all trait methods.

fn write(
    &self,
    object: impl WriteTo,
    hash: Kind
) -> Result<ObjectId, Self::Error>

Write objects using the given kind of hash into the database, returning id to reference it in subsequent reads.