Struct git2::Odb

pub struct Odb<'repo> { /* fields omitted */ }

A structure to represent a git object database

Methods

impl<'repo> Odb<'repo>

pub fn new<'a>() -> Result<Odb<'a>, Error>

Creates an object database without any backends.

pub fn reader(&self, oid: Oid) -> Result<(OdbReader, usize, ObjectType), Error>

Create object database reading stream.

Note that most backends do not support streaming reads because they store their objects as compressed/delta'ed blobs. If the backend does not support streaming reads, use the read method instead.

pub fn writer(
    &self,
    size: usize,
    obj_type: ObjectType
) -> Result<OdbWriter, Error>

Create object database writing stream.

The type and final length of the object must be specified when opening the stream. If the backend does not support streaming writes, use the write method instead.

pub fn foreach<C>(&self, callback: C) -> Result<(), Error> where
    C: FnMut(&Oid) -> bool, 

Iterate over all objects in the object database.s

pub fn read(&self, oid: Oid) -> Result<OdbObject, Error>

Read an object from the database.

pub fn read_header(&self, oid: Oid) -> Result<(usize, ObjectType), Error>

Reads the header of an object from the database without reading the full content.

pub fn write(&self, kind: ObjectType, data: &[u8]) -> Result<Oid, Error>

Write an object to the database.

pub fn exists(&self, oid: Oid) -> bool

Checks if the object database has an object.

pub fn exists_prefix(&self, short_oid: Oid, len: usize) -> Result<Oid, Error>

Potentially finds an object that starts with the given prefix.

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

Refresh the object database. This should never be needed, and is provided purely for convenience. The object database will automatically refresh when an object is not found when requested.

pub fn add_disk_alternate(&self, path: &str) -> Result<(), Error>

Adds an alternate disk backend to the object database.

Trait Implementations

impl<'repo> Drop for Odb<'repo>

fn drop(&mut self)

Executes the destructor for this type.