Struct Storage 

pub struct Storage { /* private fields */ }

Implementations

impl Storage

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

where P: AsRef<Path>,

Open a new storage instance and load its inventory.

pub fn temporary_repository( &self, rid: RepoId, ) -> Result<TempRepository, RepositoryError>

Create a Repository in a temporary directory.

This is used to prevent other processes accessing it during initialization. Usually, callers will want to move the repository to its destination after initialization in the temporary location.

pub fn path(&self) -> &Path

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

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

Trait Implementations

impl Clone for Storage

fn clone(&self) -> Storage

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl ReadStorage for Storage

type Repository = Repository

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 repository( &self, rid: RepoId, ) -> Result<<Storage as ReadStorage>::Repository, RepositoryError>

Open or create a read-only repository.

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

Return all repositories (public and private).

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

Get a repository’s identity if it exists.

impl WriteStorage for Storage

type RepositoryMut = Repository

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

Open a read-write repository.

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

Create a read-write repository.

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

Clean the repository found at rid.