Struct git_odb::Cache

source · [−]

pub struct Cache<S> { /* private fields */ }

Expand description

A way to access objects along with pre-configured thread-local caches for packed base objects as well as objects themselves.

By default, no cache will be used.

Implementations

source

impl<S> Cache<S>

source

pub fn into_inner(self) -> S

Dissolve this instance, discard all caches, and return the inner implementation.

source

pub fn with_pack_cache(
self,
create: impl Fn() -> Box<PackCache> + Send + Sync + 'static
) -> Self

Use this methods directly after creating a new instance to add a constructor for pack caches.

These are used to speed up decoding objects which are located in packs, reducing long delta chains by storing their intermediate results.

source

pub fn with_object_cache(
self,
create: impl Fn() -> Box<ObjectCache> + Send + Sync + 'static
) -> Self

Use this methods directly after creating a new instance to add a constructor for object caches.

Only use this kind of cache if the same objects are repeatedly accessed for great speedups, usually during diffing of trees.

source

pub fn set_pack_cache(
&mut self,
create: impl Fn() -> Box<PackCache> + Send + Sync + 'static
)

Set the pack cache constructor on this instance.

source

pub fn set_object_cache(
&mut self,
create: impl Fn() -> Box<ObjectCache> + Send + Sync + 'static
)

Set the object cache constructor on this instance.

source

pub fn unset_pack_cache(&mut self)

Remove the current pack cache as well as its constructor from this instance.

source

pub fn unset_object_cache(&mut self)

Remove the current object cache as well as its constructor from this instance.

Trait Implementations

source

impl<S: Clone> Clone for Cache<S>

source

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl<S> Deref for Cache<S>

type Target = S

The resulting type after dereferencing.

source

fn deref(&self) -> &Self::Target

Dereferences the value.

source

impl<S> DerefMut for Cache<S>

source

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

source

impl<S> Find for Cache<S> where
S: Find,

type Error = S::Error

The error returned by try_find()

source

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

Returns true if the object exists in the database.

source

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. Read more

source

impl<S> Find for Cache<S> where
S: Find,

type Error = S::Error

The error returned by try_find()

source

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

Returns true if the object exists in the database.

source

fn try_find<'a>(
 &self,
 id: impl AsRef<oid>,
 buffer: &'a mut Vec<u8>
) -> 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. Read more

source

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. Read more

source

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. Read more

source

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.

source

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

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

source

impl<S> From<S> for Cache<S> where
S: Find,

source

fn from(store: S) -> Self

Performs the conversion.

source

impl<S> Write for Cache<S> where
S: Write,

type Error = S::Error

The error type used for all trait methods. Read more

source

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. Read more

source

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. Read more

source

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

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

Auto Trait Implementations

impl<S> !RefUnwindSafe for Cache<S>

impl<S> Send for Cache<S> where
S: Send,

impl<S> !Sync for Cache<S>

impl<S> Unpin for Cache<S> where
S: Unpin,

impl<S> !UnwindSafe for Cache<S>

Blanket Implementations

source

impl<T, A, P> Access<T> for P where
A: Access<T>,
P: Deref<Target = A>,

type Guard = <A as Access<T>>::Guard

A guard object containing the value and keeping it alive. Read more

source

pub fn load(&self) -> >::Guard

The loading method. Read more

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T, A> DynAccess<T> for A where
A: Access<T>,
<A as Access<T>>::Guard: 'static,

source

pub fn load(&self) -> DynGuard<T>

The equivalent of Access::load.

source

impl<T> FindExt for T where
T: Find,

source

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

Like try_find(…), but flattens the Result<Option<_>> into a single Result making a non-existing object an error.

source

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

Like find(…), but flattens the Result<Option<_>> into a single Result making a non-existing object an error while returning the desired object type. Read more

source

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

Like find(…), but flattens the Result<Option<_>> into a single Result making a non-existing object an error while returning the desired object type. Read more

source

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

Like find(…), but flattens the Result<Option<_>> into a single Result making a non-existing object an error while returning the desired object type. Read more

source

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

Like find(…), but flattens the Result<Option<_>> into a single Result making a non-existing object an error while returning the desired object type. Read more

source

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

Like find(…), but flattens the Result<Option<_>> into a single Result making a non-existing object an error while returning the desired iterator type. Read more

source

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

Like find(…), but flattens the Result<Option<_>> into a single Result making a non-existing object an error while returning the desired iterator type. Read more

source

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

Like find(…), but flattens the Result<Option<_>> into a single Result making a non-existing object an error while returning the desired iterator type. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct git_odb::Cache

Implementations

impl<S> Cache<S>

pub fn into_inner(self) -> S

pub fn with_pack_cache( self, create: impl Fn() -> Box<PackCache> + Send + Sync + 'static) -> Self

pub fn with_object_cache( self, create: impl Fn() -> Box<ObjectCache> + Send + Sync + 'static) -> Self

pub fn set_pack_cache( &mut self, create: impl Fn() -> Box<PackCache> + Send + Sync + 'static)

pub fn set_object_cache( &mut self, create: impl Fn() -> Box<ObjectCache> + Send + Sync + 'static)

pub fn unset_pack_cache(&mut self)

pub fn unset_object_cache(&mut self)

Trait Implementations

impl<S: Clone> Clone for Cache<S>

fn clone(&self) -> Self

fn clone_from(&mut self, source: &Self)

impl<S> Deref for Cache<S>

type Target = S

fn deref(&self) -> &Self::Target

impl<S> DerefMut for Cache<S>

fn deref_mut(&mut self) -> &mut Self::Target

impl<S> Find for Cache<S> where S: Find,

type Error = S::Error

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

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

impl<S> Find for Cache<S> where S: Find,

type Error = S::Error

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

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

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>

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

fn pack_offsets_and_oid(&self, pack_id: u32) -> Option<Vec<(u64, ObjectId)>>

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

impl<S> From<S> for Cache<S> where S: Find,

fn from(store: S) -> Self

impl<S> Write for Cache<S> where S: Write,

type Error = S::Error

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

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

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

Auto Trait Implementations

impl<S> !RefUnwindSafe for Cache<S>

impl<S> Send for Cache<S> where S: Send,

impl<S> !Sync for Cache<S>

impl<S> Unpin for Cache<S> where S: Unpin,

impl<S> !UnwindSafe for Cache<S>

Blanket Implementations

impl<T, A, P> Access<T> for P where A: Access<T>, P: Deref<Target = A>,

type Guard = <A as Access<T>>::Guard

pub fn load(&self) -> <P as Access<T>>::Guard

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T, A> DynAccess<T> for A where A: Access<T>, <A as Access<T>>::Guard: 'static,

pub fn load(&self) -> DynGuard<T>

impl<T> FindExt for T where T: Find,

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

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

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

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

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

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

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

pub fn with_pack_cache(
self,
create: impl Fn() -> Box<PackCache> + Send + Sync + 'static
) -> Self

pub fn with_object_cache(
self,
create: impl Fn() -> Box<ObjectCache> + Send + Sync + 'static
) -> Self

pub fn set_pack_cache(
&mut self,
create: impl Fn() -> Box<PackCache> + Send + Sync + 'static
)

pub fn set_object_cache(
&mut self,
create: impl Fn() -> Box<ObjectCache> + Send + Sync + 'static
)

impl<S> Find for Cache<S> where
S: Find,

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

impl<S> Find for Cache<S> where
S: Find,

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

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>

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

fn pack_offsets_and_oid(&self, pack_id: u32) -> Option<Vec<(u64, ObjectId )>>

impl<S> From<S> for Cache<S> where
S: Find,

impl<S> Write for Cache<S> where
S: Write,

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

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

impl<S> Send for Cache<S> where
S: Send,

impl<S> Unpin for Cache<S> where
S: Unpin,

impl<T, A, P> Access<T> for P where
A: Access<T>,
P: Deref<Target = A>,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, A> DynAccess<T> for A where
A: Access<T>,
<A as Access<T>>::Guard: 'static,

impl<T> FindExt for T where
T: Find,

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

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

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

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

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

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

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

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

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,