Struct git_odb::linked::Store

pub struct Store {
    pub dbs: Vec<Store>,
}

A database with a list of compound databases created by traversing git alternates files.

It does not contain any objects itself.

Fields

dbs: Vec<Store>

The compound databases containing the actual objects.

Implementations

impl Store

pub fn at(objects_directory: impl Into<PathBuf>) -> Result<Self, Error>

Instantiate an instance at the given objects_directory, commonly .git/objects.

git alternate files will be traversed to build a chain of compound::Store instances.

impl Store

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

Return true if the given object id is contained in the store.

impl Store

pub fn iter(&self) -> AllObjects<&Store>

Return an iterator over all objects in all linked databases, database after database, first packed objects with the ‘best’ packs first, followed by loose objects. For specialized iterations, use the dbs fields directly as all databases are accessible.

pub fn arc_iter(self: &Arc<Store>) -> AllObjects<Arc<Store>>

Like iter() but works with this instance living in an Arc

Useful in conjunction with 'static threads.

Trait Implementations

impl Find for Store

type Error = Error

The error returned by try_find()

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

Find an object matching id in the database while placing its raw, undecoded data into buffer. A pack_cache can be used to speed up subsequent lookups, set it to crate::cache::Never if the workload isn’t suitable for caching.

fn location_by_oid(
    &self,
    id: impl AsRef<oid>,
    buf: &mut Vec<u8>
) -> Option<Location>

Find the packs location where an object with id can be found in the database, or None if there is no pack holding the object.

fn bundle_by_pack_id(&self, pack_id: u32) -> Option<&Bundle>

Find the bundle matching pack_id, or None if there is no such pack.

fn entry_by_location(&self, location: &Location) -> Option<Entry<'_>>

Return the find::Entry for location if it is backed by a pack.

impl Find for &Store

type Error = Error

The error returned by try_find()

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

Find an object matching id in the database while placing its raw, undecoded data into buffer. A pack_cache can be used to speed up subsequent lookups, set it to crate::cache::Never if the workload isn’t suitable for caching.

fn location_by_oid(
    &self,
    id: impl AsRef<oid>,
    buf: &mut Vec<u8>
) -> Option<Location>

Find the packs location where an object with id can be found in the database, or None if there is no pack holding the object.

fn bundle_by_pack_id(&self, pack_id: u32) -> Option<&Bundle>

Find the bundle matching pack_id, or None if there is no such pack.

fn entry_by_location(&self, location: &Location) -> Option<Entry<'_>>

Return the find::Entry for location if it is backed by a pack.

impl TryFrom<PathBuf> for Store

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: PathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl Write for Store

type Error = Error

The error type used for all trait methods.

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

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

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

As write, but takes an object kind along with its encoded bytes.

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

As write, but takes an input stream. This is commonly used for writing blobs directly without reading them to memory first.