Struct Home 

pub struct Home { /* private fields */ }

Radicle home.

Implementations

impl Home

pub fn new(home: impl Into<PathBuf>) -> Result<Home, Error>

Creates the Radicle Home directories.

The home path is used as the base directory for all necessary subdirectories.

If home does not already exist then it and any subdirectories are created using fs::create_dir_all.

The home path is also canonicalized using fs::canonicalize.

All necessary subdirectories are also created.

pub fn load<P>(home: P) -> Result<Home, Error>

where P: AsRef<Path>,

Load existing Radicle Home directories.

The home path is the expected base directory for all necessary subdirectories.

Errors

If home or any of the subdirectories are missing an io::Error is returned.

pub fn path(&self) -> &Path

pub fn storage(&self) -> PathBuf

The /storage directory under Home::path.

pub fn config(&self) -> PathBuf

The config.json file path under Home::path.

pub fn keys(&self) -> PathBuf

The /keys directory under Home::path.

pub fn node(&self) -> PathBuf

The /node directory under Home::path.

pub fn cobs(&self) -> PathBuf

The /cobs directory under Home::path.

pub fn socket_from_env(&self) -> PathBuf

The location of the control socket of the node. If the environment variable with name env::RAD_SOCKET is set, its value is used. Otherwise, the default socket name, which is relative to this Home, is used (see Self::socket_default).

pub fn socket_default(&self) -> PathBuf

The default location of the control socket of the node. The returned value only depends on self, and not on any environment variables.

See also Self::socket_from_env.

pub fn notifications_mut(&self) -> Result<Store<Write>, Error>

Return a read-write handle to the notifications database.

pub fn policies_mut(&self) -> Result<Store<Write>, Error>

Return a read-write handle to the policies store of the node.

pub fn database(&self, config: Config) -> Result<Database, Error>

Return a handle to a read-only database of the node.

pub fn database_mut(&self, config: Config) -> Result<Database, Error>

Return a handle to the database of the node.

pub fn addresses(&self, config: Config) -> Result<impl Store + use<>, Error>

Returns the address store.

pub fn routing(&self, config: Config) -> Result<impl Store + use<>, Error>

Returns the routing store.

pub fn routing_mut(&self, config: Config) -> Result<impl Store + use<>, Error>

Returns the routing store, mutably.

pub fn cobs_db(&self) -> Result<Store<Read>, Error>

Get read access to the COBs cache.

pub fn cobs_db_mut(&self) -> Result<Store<Write>, Error>

Get write access to the COBs cache.

pub fn issues<'a, Repo>( &self, repository: &'a Repo, ) -> Result<Cache<'a, Repo, ReadOnly, Store<Read>>, Error>

where Repo: ReadRepository + Store<Namespace = PublicKey>,

Return a read-only handle for the issues cache.

pub fn issues_mut<'a, 'b, Repo, Signer>( &self, repository: &'a Repo, signer: &'b Signer, ) -> Result<Cache<'a, Repo, WriteAs<'b, Signer>, Store<Write>>, Error>

where Repo: ReadRepository + Store<Namespace = PublicKey>,

Return a read-write handle for the issues cache.

pub fn patches<'a, Repo>( &self, repository: &'a Repo, ) -> Result<Cache<'a, Repo, ReadOnly, Store<Read>>, Error>

where Repo: ReadRepository + Store<Namespace = PublicKey>,

Return a read-only handle for the patches cache.

pub fn patches_mut<'a, 'b, Repo, Signer>( &self, repository: &'a Repo, signer: &'b Signer, ) -> Result<Cache<'a, Repo, WriteAs<'b, Signer>, Store<Write>>, Error>

where Repo: ReadRepository + Store<Namespace = PublicKey>,

Return a read-write handle for the patches cache.

Trait Implementations

impl Clone for Home

fn clone(&self) -> Home

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Home

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

Formats the value using the given formatter.