Sebastian Thielmake fmt7cf35454 years agoHistory
145 lines · 5.3 KB · Rust
RawDownload
use std::{cell::RefCell, path::PathBuf}; use git_hash::ObjectId; use crate::head; /// The head reference, as created from looking at `.git/HEAD`, able to represent all of its possible states.////// Note that like [`Reference`], this type's data is snapshot of persisted state on disk.pub struct Head<'repo> {    /// One of various possible states for the HEAD reference    pub kind: head::Kind,    pub(crate) repo: &'repo crate::Repository,} /// An [ObjectId] with access to a repository.#[derive(Clone, Copy)]pub struct Id<'r> {    /// The actual object id    pub(crate) inner: ObjectId,    pub(crate) repo: &'r crate::Repository,} /// A decoded object with a reference to its owning repository.////// ## Limitations////// Note that it holds a reference to a buffer of it's associated repository handle, so there/// can only be one at a time, per handle.pub struct Object<'repo> {    /// The id of the object    pub id: ObjectId,    /// The kind of the object    pub kind: git_object::Kind,    /// The fully decoded object data    pub data: Vec<u8>,    pub(crate) repo: &'repo crate::Repository,} impl<'a> Drop for Object<'a> {    fn drop(&mut self) {        self.repo.reuse_buffer(&mut self.data);    }} /// A decoded tree object with access to its owning repository.////// Please note that the limitations described in [Object] apply here as well.pub struct Tree<'repo> {    /// The id of the tree    pub id: ObjectId,    /// The fully decoded tree data    pub data: Vec<u8>,    pub(crate) repo: &'repo crate::Repository,} impl<'a> Drop for Tree<'a> {    fn drop(&mut self) {        self.repo.reuse_buffer(&mut self.data);    }} /// A decoded commit object with access to its owning repository.////// Please note that the limitations described in [Object] apply here as well.pub struct Commit<'repo> {    /// The id of the commit    pub id: ObjectId,    /// The fully decoded commit data    pub data: Vec<u8>,    pub(crate) repo: &'repo crate::Repository,} impl<'a> Drop for Commit<'a> {    fn drop(&mut self) {        self.repo.reuse_buffer(&mut self.data);    }} /// A detached, self-contained object, without access to its source repository.////// Use it if an `ObjectRef` should be sent over thread boundaries or stored in collections.#[derive(Clone)]pub struct DetachedObject {    /// The id of the object    pub id: ObjectId,    /// The kind of the object    pub kind: git_object::Kind,    /// The fully decoded object data    pub data: Vec<u8>,} /// A reference that points to an object or reference, with access to its source repository.////// Note that these are snapshots and won't recognize if they are stale.pub struct Reference<'r> {    /// The actual reference data    pub inner: git_ref::Reference,    pub(crate) repo: &'r crate::Repository,} /// A thread-local handle to interact with a repository from a single thread.////// It is `Send` but **not** `Sync` - for the latter you can convert it `to_sync()`./// Note that it clones itself so that it is empty, requiring the user to configure each clone separately, specifically/// and explicitly. This is to have the fastest-possible default configuration available by default, but allow/// those who experiment with workloads to get speed boosts of 2x or more.pub struct Repository {    /// A ref store with shared ownership (or the equivalent of it).    pub refs: crate::RefStore,    /// A way to access objects.    pub objects: crate::OdbHandle,     pub(crate) work_tree: Option<PathBuf>,    /// The kind of hash that is used or should be used for object ids    pub(crate) object_hash: git_hash::Kind,    /// Access to all repository configuration, must be hidden as there is a lot figure out.    pub(crate) config: crate::Config,    /// A free-list of re-usable object backing buffers    pub(crate) bufs: RefCell<Vec<Vec<u8>>>,} /// An instance with access to everything a git repository entails, best imagined as container implementing `Sync + Send` for _most_/// for system resources required to interact with a `git` repository which are loaded in once the instance is created.////// Use this type to reference it in a threaded context for creation the creation of a thread-local [`Repositories`][crate::Repository].////// Note that this type purposefully isn't very useful until it is converted into a thread-local repository with `to_thread_local()`,/// it's merely meant to be able to exist in a `Sync` context.pub struct ThreadSafeRepository {    /// A store for references to point at objects    pub refs: crate::RefStore,    /// A store for objects that contain data    #[cfg(feature = "unstable")]    pub objects: git_features::threading::OwnShared<git_odb::Store>,    #[cfg(not(feature = "unstable"))]    pub(crate) objects: git_features::threading::OwnShared<git_odb::Store>,    /// The path to the worktree at which to find checked out files    pub work_tree: Option<PathBuf>,    pub(crate) object_hash: git_hash::Kind,    // TODO: git-config should be here - it's read a lot but not written much in must applications, so shouldn't be in `State`.    //       Probably it's best reload it on signal (in servers) or refresh it when it's known to have been changed similar to how    //       packs are refreshed. This would be `git_config::fs::Config` when ready.    pub(crate) config: crate::Config,}