Struct jj_lib::local_backend::LocalBackend

pub struct LocalBackend { /* private fields */ }

Implementations

impl LocalBackend

pub fn name() -> &'static str

pub fn init(store_path: &Path) -> Self

pub fn load(store_path: &Path) -> Self

Trait Implementations

impl Backend for LocalBackend

fn as_any(&self) -> &dyn Any

fn name(&self) -> &str

A unique name that identifies this backend. Written to .jj/repo/store/backend when the repo is created.

fn commit_id_length(&self) -> usize

The length of commit IDs in bytes.

fn change_id_length(&self) -> usize

The length of change IDs in bytes.

fn root_commit_id(&self) -> &CommitId

fn root_change_id(&self) -> &ChangeId

fn empty_tree_id(&self) -> &TreeId

fn concurrency(&self) -> usize

An estimate of how many concurrent requests this backend handles well. A local backend like the Git backend (at until it supports partial clones) may want to set this to 1. A cloud-backed backend may want to set it to 100 or so.

fn read_file<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _path: &'life1 RepoPath, id: &'life2 FileId ) -> Pin<Box<dyn Future<Output = BackendResult<Box<dyn Read>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

fn write_file( &self, _path: &RepoPath, contents: &mut dyn Read ) -> BackendResult<FileId>

fn read_symlink<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _path: &'life1 RepoPath, id: &'life2 SymlinkId ) -> Pin<Box<dyn Future<Output = Result<String, BackendError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

fn write_symlink( &self, _path: &RepoPath, target: &str ) -> Result<SymlinkId, BackendError>

fn read_tree<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _path: &'life1 RepoPath, id: &'life2 TreeId ) -> Pin<Box<dyn Future<Output = BackendResult<Tree>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

fn write_tree(&self, _path: &RepoPath, tree: &Tree) -> BackendResult<TreeId>

fn read_conflict( &self, _path: &RepoPath, id: &ConflictId ) -> BackendResult<Conflict>

fn write_conflict( &self, _path: &RepoPath, conflict: &Conflict ) -> BackendResult<ConflictId>

fn read_commit<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 CommitId ) -> Pin<Box<dyn Future<Output = BackendResult<Commit>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn write_commit( &self, commit: Commit, sign_with: Option<&mut SigningFn<'_>> ) -> BackendResult<(CommitId, Commit)>

Writes a commit and returns its ID and the commit itself. The commit should contain the data that was actually written, which may differ from the data passed in. For example, the backend may change the committer name to an authenticated user’s name, or the backend’s timestamps may have less precision than the millisecond precision in Commit.

fn gc(&self, _index: &dyn Index, _keep_newer: SystemTime) -> BackendResult<()>

Perform garbage collection.

impl Debug for LocalBackend

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

Formats the value using the given formatter.