Struct Store 

pub struct Store<T> { /* private fields */ }

Policy configuration.

Implementations

impl Store<Read>

pub fn reader<P>(path: P) -> Result<Store<Read>, Error>

where P: AsRef<Path>,

Same as Self::open, but in read-only mode. This is useful to have multiple open databases, as no locking is required.

pub fn memory() -> Result<Store<Read>, Error>

Create a new in-memory address book.

impl Store<Write>

pub fn open<P>(path: P) -> Result<Store<Write>, Error>

where P: AsRef<Path>,

Open a policy store at the given path. Creates a new store if it doesn’t exist.

pub fn memory() -> Result<Store<Write>, Error>

Create a new in-memory address book.

pub fn read_only(self) -> Store<Read>

Get a read-only version of this store.

pub fn follow( &mut self, id: &PublicKey, alias: Option<&Alias>, ) -> Result<bool, Error>

Follow a node.

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

Seed a repository.

pub fn set_follow_policy( &mut self, id: &PublicKey, policy: Policy, ) -> Result<bool, Error>

Set a node’s follow policy.

pub fn set_seed_policy( &mut self, id: &RepoId, policy: Policy, ) -> Result<bool, Error>

Set a repository’s seeding policy.

pub fn unfollow(&mut self, id: &PublicKey) -> Result<bool, Error>

Unfollow a node.

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

Unseed a repository.

pub fn unblock_rid(&mut self, id: &RepoId) -> Result<bool, Error>

Unblock a repository.

pub fn unblock_nid(&mut self, id: &PublicKey) -> Result<bool, Error>

Unblock a remote.

impl<T> Store<T>

Read methods for Config. This implies that a Config<Write> can access these functions as well.

pub fn is_following(&self, id: &PublicKey) -> Result<bool, Error>

Check if a node is followed.

pub fn is_seeding(&self, id: &RepoId) -> Result<bool, Error>

Check if a repository is seeded.

pub fn follow_policy( &self, id: &PublicKey, ) -> Result<Option<FollowPolicy>, Error>

Get a node’s follow policy.

pub fn seed_policy(&self, id: &RepoId) -> Result<Option<SeedPolicy>, Error>

Get a repository’s seeding policy.

pub fn follow_policies(&self) -> Result<FollowPolicies<'_>, Error>

Get node follow policies.

pub fn seed_policies(&self) -> Result<SeedPolicies<'_>, Error>

Get repository seed policies.

pub fn nodes_by_alias<'a>( &'a self, alias: &Alias, ) -> Result<NodeAliasIter<'a>, Error>

Trait Implementations

impl<T> AliasStore for Store<T>

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

Retrieve alias of given node. Calls Self::node_policy under the hood.

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

Return all the NodeIds that match the alias.

impl<T> Debug for Store<T>

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

Formats the value using the given formatter.