Struct FilesRefStore 

pub struct FilesRefStore { /* private fields */ }

Loose + packed ref storage on disk.

On Windows, updates whose storage path includes a reserved device name or another non-round-tripping path component are rejected with RefStoreError::InvalidRefName so repositories stay readable by system Git.

Implementations

impl FilesRefStore

pub fn open(config: FilesRefStoreConfig) -> Self

Open a files backend at config.git_dir.

pub fn from_git_dir(git_dir: impl Into<PathBuf>) -> Result<Self>

Convenience constructor for a simple repository directory.

Trait Implementations

impl Debug for FilesRefStore

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl RefStore for FilesRefStore

fn format(&self) -> RefStorageFormat

Which on-disk or logical format this store uses.

fn read_raw(&self, name: &str) -> Result<Option<RawRef>>

Read the stored value for name without resolving symbolic targets.

fn for_each_ref( &self, prefix: &str, f: &mut dyn FnMut(&RefEntry) -> ControlFlow<()>, ) -> Result<()>

Invoke f for each ref whose name starts with prefix, in sorted name order.

fn prepare( &self, txn: RefTransaction, ) -> Result<Box<dyn PreparedRefTransaction + Send + '_>, RefStoreError>

Validate txn, take locks, and return a committable batch.

fn reflog_exists(&self, name: &str) -> Result<bool>

Whether a reflog is present for name.

fn for_each_reflog_entry( &self, name: &str, reverse: bool, f: &mut dyn FnMut(&ReflogEntry) -> ControlFlow<()>, ) -> Result<()>

Iterate reflog entries for name (oldest first unless reverse).

fn create_reflog(&self, name: &str) -> Result<()>

Create an empty reflog file/record for name.

fn delete_reflog(&self, name: &str) -> Result<()>

Remove the reflog for name.

fn replace_reflog(&self, name: &str, entries: Vec<ReflogEntry>) -> Result<()>

Replace the entire reflog (used by expire/delete-entries).

fn rewrite_reflog( &self, name: &str, transform: &mut dyn FnMut(Vec<ReflogEntry>) -> Result<Vec<ReflogEntry>>, ) -> Result<()>

Read a reflog under the backend writer lock, transform it, and write it back atomically.

fn for_each_reflog_ref( &self, f: &mut dyn FnMut(&str) -> ControlFlow<()>, ) -> Result<()>

Invoke f for each ref name that has a reflog, in sorted order.

fn as_files(&self) -> Option<&FilesRefStore>

The files backend behind this store, when it is one.

fn resolve(&self, name: &str) -> Result<ObjectId>

Resolve name to an object id, following symbolic refs.

fn for_each_physical_stack_ref( &self, prefix: &str, f: &mut dyn FnMut(&RefEntry) -> ControlFlow<()>, ) -> Result<()>

Walk refs stored in this handle’s physical reftable stack (reftable/ under the store git directory). On the files backend this matches Self::for_each_ref.

fn verify_update_targets( &self, updates: &[RefUpdate], ) -> Result<(), RefStoreError>

Check the objects updates would point refs at, without taking any lock or writing.

fn ref_lock_wait(&self) -> LockWait

How long grit-lib retries RefStoreError::LockHeld from Self::prepare.