Type Definition gix_odb::HandleArc

impl Cache<Handle<Arc<Store>>>

pub fn into_arc(self) -> Result<Cache<Handle<Arc<Store>>>>

No op, as we are containing an arc handle already.

impl<S> Cache<S>

pub fn into_inner(self) -> S

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

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.

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.

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

Set the pack cache constructor on this instance.

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

Set the object cache constructor on this instance.

pub fn has_object_cache(&self) -> bool

Return true if an object cache is present.

pub fn has_pack_cache(&self) -> bool

Return true if a pack cache is present.

pub fn unset_pack_cache(&mut self)

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

pub fn unset_object_cache(&mut self)

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

Trait Implementations§

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

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

impl<S> Deref for Cache<S>

type Target = S

The resulting type after dereferencing.

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

Dereferences the value.

impl<S> DerefMut for Cache<S>

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

Mutably dereferences the value.

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

type Error = <S as Find>::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>, Option<Location>)>, Self::Error>

Find an object matching id in the database while placing its raw, decoded 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

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

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

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

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

type Error = <S as Find>::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, possibly encoded data into buffer. Read more

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

fn from(store: S) -> Self

Converts to this type from the input type.

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

type Error = <S as Header>::Error

The error returned by try_header().

fn try_header(&self, id: impl AsRef<oid>) -> Result<Option<Header>, Self::Error>

Try to read the header of the object associated with id or return None if it could not be found.

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

type Error = <S as Write>::Error

The error type used for all trait methods. Read more

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.

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.

Auto Trait Implementations§

impl<S> !UnwindSafe for Cache<S>

Blanket Implementations§

impl<T, A, P> Access<T> for Pwhere A: Access<T> + ?Sized, P: Deref<Target = A>,

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

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

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

The loading method. Read more

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

The equivalent of Access::load.

impl<T> FindExt for Twhere T: Find,

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

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

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

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

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

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

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

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

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

impl<T> FindExt for Twhere T: Find,

fn find<'a>( &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.

fn find_commit<'a>( &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.

fn find_tree<'a>( &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.

fn find_tag<'a>( &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.

fn find_blob<'a>( &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.

fn find_commit_iter<'a>( &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.

fn find_tree_iter<'a>( &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.

fn find_tag_iter<'a>( &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.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> HeaderExt for Twhere T: Header,

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

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.