Struct radicle::storage::git::Storage

pub struct Storage { /* private fields */ }

Implementations

impl Storage

pub fn open<P: AsRef<Path>>(path: P, info: UserInfo) -> Result<Self, Error>

Open a new storage instance and load its inventory.

pub fn lock_repository( &self, rid: RepoId, ) -> Result<(Repository, TempDir), RepositoryError>

Create a Repository in a temporary directory.

N.b. it is important to keep the TempDir in scope while using the Repository. If it is dropped, any action on the Repository will fail.

pub fn path(&self) -> &Path

pub fn repositories_by_id<'a>( &self, rids: impl Iterator<Item = &'a RepoId>, ) -> Result<Vec<RepositoryInfo<Verified>>, RepositoryError>

pub fn inspect(&self) -> Result<(), RepositoryError>

Trait Implementations

impl Clone for Storage

fn clone(&self) -> Storage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Storage

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

Formats the value using the given formatter.

impl ReadStorage for Storage

type Repository = Repository

type InventoryRef<'a> = InventoryLock<'a>

fn info(&self) -> &UserInfo

Get user info for this storage.

fn path(&self) -> &Path

Get the storage base path.

fn path_of(&self, rid: &RepoId) -> PathBuf

Get a repository’s path.

fn contains(&self, rid: &RepoId) -> Result<bool, RepositoryError>

Check whether storage contains a repository.

fn inventory_ref<'a, 's: 'a>(&'s self) -> InventoryLock<'a>

Return a reference to the inventory. Note that this function may hold a lock to the inventory.

fn inventory(&self) -> Result<Inventory, Error>

Get the inventory of repositories hosted under this storage. This function should typically only return public repositories.

fn insert(&self, rid: RepoId)

Insert this repository into the inventory.

fn repository(&self, rid: RepoId) -> Result<Self::Repository, RepositoryError>

Open or create a read-only repository.

fn repositories(&self) -> Result<Vec<RepositoryInfo<Verified>>, Error>

Return all repositories (public and private).

fn get(&self, rid: RepoId) -> Result<Option<Doc<Verified>>, RepositoryError>

Get a repository’s identity if it exists.

impl WriteStorage for Storage

type RepositoryMut = Repository

fn repository_mut( &self, rid: RepoId, ) -> Result<Self::RepositoryMut, RepositoryError>

Open a read-write repository.

fn create(&self, rid: RepoId) -> Result<Self::RepositoryMut, Error>

Create a read-write repository.

fn clean(&self, rid: RepoId) -> Result<Vec<RemoteId>, RepositoryError>

Clean the repository found at rid.