gix_ref/store/file/
mod.rs

1use std::{
2    borrow::Cow,
3    path::{Path, PathBuf},
4};
5
6use crate::{bstr::BStr, store::WriteReflog, Namespace};
7
8/// A store for reference which uses plain files.
9///
10/// Each ref is represented as a single file on disk in a folder structure that follows the relative path
11/// used to identify [references][crate::Reference].
12#[derive(Debug, Clone)]
13pub struct Store {
14    /// The location at which loose references can be found as per conventions of a typical git repository.
15    ///
16    /// Typical base paths are `.git` repository folders.
17    git_dir: PathBuf,
18    /// Possibly the common directory at which to find shared references. Only set if this `Store` is for a work tree.
19    common_dir: Option<PathBuf>,
20    /// The kind of hash to assume in a couple of situations. Note that currently we are able to read any valid hash from files
21    /// which might want to change one day.
22    object_hash: gix_hash::Kind,
23    /// The amount of bytes needed for `mmap` to be used to open packed refs.
24    packed_buffer_mmap_threshold: u64,
25
26    /// The way to handle reflog edits
27    pub write_reflog: WriteReflog,
28    /// The namespace to use for edits and reads
29    pub namespace: Option<Namespace>,
30    /// This is only needed on Windows, where some device names are reserved at any level of a path, so that
31    /// reading or writing `refs/heads/CON` for example would read from the console, or write to it.
32    pub prohibit_windows_device_names: bool,
33    /// If set, we will convert decomposed unicode like `a\u308` into precomposed unicode like `ä` when reading
34    /// ref names from disk.
35    /// Note that this is an internal operation that isn't observable on the outside, but it's needed for lookups
36    /// to packed-refs or symlinks to work correctly.
37    /// Iterated references will be returned verbatim, thus when sending them over the wire they have to be precomposed
38    /// as needed.
39    pub precompose_unicode: bool,
40    /// A packed buffer which can be mapped in one version and shared as such.
41    /// It's updated only in one spot, which is prior to reading it based on file stamps.
42    /// Doing it like this has the benefit of being able to hand snapshots out to people without blocking others from updating it.
43    packed: packed::modifiable::MutableSharedBuffer,
44}
45
46mod access {
47    use std::path::Path;
48
49    /// Mutation
50    impl file::Store {
51        /// Set the amount of `bytes` needed for the `.git/packed-refs` file to be memory mapped.
52        /// Returns the previous value, which is always 32KB.
53        pub fn set_packed_buffer_mmap_threshold(&mut self, mut bytes: u64) -> u64 {
54            std::mem::swap(&mut self.packed_buffer_mmap_threshold, &mut bytes);
55            bytes
56        }
57    }
58
59    use crate::file;
60
61    /// Access
62    impl file::Store {
63        /// Return the `.git` directory at which all references are loaded.
64        ///
65        /// For worktrees, this is the linked work-tree private ref location,
66        /// then [`common_dir()`][file::Store::common_dir()] is `Some(parent_git_dir)`.
67        pub fn git_dir(&self) -> &Path {
68            &self.git_dir
69        }
70
71        /// If this is a linked work tree, there will be `Some(git_dir)` pointing to the parent repository,
72        /// while [`git_dir()`][file::Store::git_dir()] points to the location holding linked work-tree private references.
73        pub fn common_dir(&self) -> Option<&Path> {
74            self.common_dir.as_deref()
75        }
76
77        /// Similar to [`common_dir()`][file::Store::common_dir()], but it will produce either the common-dir, or the git-dir if the former
78        /// isn't present.
79        ///
80        /// This is also the directory in which the packed references file would be placed.
81        pub fn common_dir_resolved(&self) -> &Path {
82            self.common_dir.as_deref().unwrap_or(&self.git_dir)
83        }
84    }
85}
86
87/// A transaction on a file store
88pub struct Transaction<'s, 'p> {
89    store: &'s Store,
90    packed_transaction: Option<crate::store_impl::packed::Transaction>,
91    updates: Option<Vec<transaction::Edit>>,
92    packed_refs: transaction::PackedRefs<'p>,
93}
94
95pub(in crate::store_impl::file) fn path_to_name<'a>(path: impl Into<Cow<'a, Path>>) -> Cow<'a, BStr> {
96    let path = gix_path::into_bstr(path.into());
97    gix_path::to_unix_separators_on_windows(path)
98}
99
100///
101pub mod loose;
102mod overlay_iter;
103
104///
105pub mod iter {
106    pub use super::overlay_iter::{LooseThenPacked, Platform};
107
108    ///
109    pub mod loose_then_packed {
110        pub use super::super::overlay_iter::Error;
111    }
112}
113
114///
115pub mod log;
116
117///
118pub mod find;
119
120///
121pub mod transaction;
122
123///
124pub mod packed;
125
126mod raw_ext;
127pub use raw_ext::ReferenceExt;
gix_ref/store/file/mod.rs

gix_ref/store/file/
mod.rs
