Struct Profile 

pub struct Profile {
    pub home: Home,
    pub storage: Storage,
    pub keystore: Keystore,
    pub public_key: PublicKey,
    pub config: Config,
}

Fields

home: Home

storage: Storage

keystore: Keystore

public_key: PublicKey

config: Config

Implementations

impl Profile

pub fn init( home: Home, alias: Alias, passphrase: Option<Zeroizing<String>>, seed: Seed, ) -> Result<Profile, Error>

pub fn load() -> Result<Profile, Error>

pub fn id(&self) -> &PublicKey

pub fn info(&self) -> UserInfo

pub fn hints(&self) -> bool

pub fn did(&self) -> Did

pub fn signer(&self) -> Result<BoxedDevice, SignerError>

pub fn home(&self) -> &Home

Get Radicle home.

pub fn policies(&self) -> Result<Config<Read>, Error>

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

pub fn aliases(&self) -> Aliases

Return a multi-source store for aliases.

pub fn add_inventory(&self, rid: RepoId, node: &mut Node) -> Result<bool, Error>

Add the repo to our inventory. If the node is offline, adds it directly to the database.

pub fn seed( &self, rid: RepoId, scope: Scope, node: &mut Node, ) -> Result<bool, Error>

Seed a repository by first trying to seed through the node, and if the node isn’t running, by updating the policy database directly. If the repo is available locally, we also add it to our inventory.

pub fn unseed(&self, rid: RepoId, node: &mut Node) -> Result<bool, Error>

Unseed a repository by first trying to unseed through the node, and if the node isn’t running, by updating the policy database directly.

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

Return a handle to the database of the node, with SQLite configuration from Self::config applied.

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

Return a handle to a read-only database of the node, with SQLite configuration from Self::config applied.

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

Returns the routing store, with SQLite configuration from Self::config applied.

Methods from Deref<Target = Home>

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 AliasStore for Profile

fn alias(&self, nid: &PublicKey) -> Option<Alias>

Returns alias of a NodeId.

fn reverse_lookup(&self, alias: &Alias) -> BTreeMap<Alias, BTreeSet<PublicKey>>

Return all the NodeIds that match the alias.

impl Clone for Profile

fn clone(&self) -> Profile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Profile

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

Formats the value using the given formatter.

impl Deref for Profile

type Target = Home

The resulting type after dereferencing.

fn deref(&self) -> &<Profile as Deref>::Target

Dereferences the value.

impl DerefMut for Profile

fn deref_mut(&mut self) -> &mut <Profile as Deref>::Target

Mutably dereferences the value.