Trait ReadStorage

pub trait ReadStorage {
    type Repository: ReadRepository;

    // Required methods
    fn info(&self) -> &UserInfo;
    fn path(&self) -> &Path;
    fn path_of(&self, rid: &RepoId) -> PathBuf;
    fn contains(&self, rid: &RepoId) -> Result<bool, RepositoryError>;
    fn repositories(&self) -> Result<Vec<RepositoryInfo>, Error>;
    fn repository(
        &self,
        rid: RepoId,
    ) -> Result<Self::Repository, RepositoryError>;

    // Provided method
    fn get(&self, rid: RepoId) -> Result<Option<Doc>, RepositoryError> { ... }
}

Read-only operations on a storage instance.

Required Associated Types

type Repository: ReadRepository

Required Methods

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 repositories(&self) -> Result<Vec<RepositoryInfo>, Error>

Return all repositories (public and private).

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

Open or create a read-only repository.

Provided Methods

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

Get a repository’s identity if it exists.

Implementors

impl ReadStorage for Storage

type Repository = Repository

impl<T, S> ReadStorage for T

where T: Deref<Target = S>, S: ReadStorage + 'static,

type Repository = <S as ReadStorage>::Repository