Struct git_odb::linked::Store

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

👎 Deprecated since 0.27.0:

superseded by git_odb::Store

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

It does not contain any objects itself.

Furthermore, it won’t handle multi-pack indices and might be removed at some point in the future to allow focussing on a single database.

Fields

dbs: Vec<Store>

👎 Deprecated since 0.27.0:

superseded by git_odb::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.

pub fn refresh(&mut self) -> Result<&mut Self, Error>

Efficiently refresh the stable data like memory maps of packs or linked repositories to reflect the changed state on disk.

impl Store

pub fn to_cache(&self) -> Cache<&Self>

Create a store handle with a shared reference to this instance.

pub fn to_cache_arc(self: &Arc<Self>) -> Cache<Arc<Self>>

Create a store handle with a shared reference to this instance, if this instance is kept in an Arc.

pub fn to_cache_shared(self: &OwnShared<Self>) -> Cache<OwnShared<Self>>

Create a store handle with a shared reference to this instance, if this instance is kept in an Rc/Arc.

The latter depends on the git-features/parallel feature toggle.

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.

pub fn rc_iter(self: &Rc<Store>) -> AllObjects<Rc<Store>>

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

Trait Implementations

impl Find for Store

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

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

type Error = Error

The error returned by try_find()

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

Like Find::try_find(), but with support for controlling the pack cache. 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 pack_offsets_and_oid(&self, pack_id: u32) -> Option<Vec<(u64, ObjectId)>>

Obtain a vector of all offsets, in index order, along with their object id.

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

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

fn try_find(
    &self,
    id: impl AsRef<oid>,
    buffer: &'a mut Vec<u8, Global>
) -> Result<Option<(Data<'a>, Option<Location>)>, 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.

impl Find for Store

type Error = Error

The error returned by try_find()

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

Returns true if the object exists in the database.

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

Find an object matching id in the database while placing its raw, undecoded data into buffer.

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: impl WriteTo) -> Result<ObjectId, Self::Error>

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

fn write_buf(&self, object: Kind, from: &[u8]) -> 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
) -> 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.