Struct NetworkManager 

pub struct NetworkManager { /* private fields */ }

Persistent manager for network membership and folder associations.

Implementations

impl NetworkManager

pub fn new( db: NodeDatabase, local_node: PublicKey, member_keys: Arc<RwLock<HashSet<PublicKey>>>, ) -> Result<Self>

Open the network database.

Errors

Returns an error if existing state cannot be read.

pub fn with_logger( db: NodeDatabase, local_node: PublicKey, logger: NetworkLogger, member_keys: Arc<RwLock<HashSet<PublicKey>>>, ) -> Result<Self>

Open the network database with a network logger.

Errors

Returns an error if existing state cannot be read.

pub const fn logger(&self) -> &Option<NetworkLogger>

Return a reference to the network logger, if set.

pub fn set_logger(&mut self, logger: NetworkLogger)

Set the network logger after construction.

pub const fn database(&self) -> &NodeDatabase

Return a reference to the underlying database.

pub const fn local_node(&self) -> &PublicKey

Return the local node’s public key.

pub fn create( &mut self, name: &str, options: NetworkOptions, ) -> Result<NetworkId>

Create and persist a network owned by the local node.

Errors

Returns an error for an empty/duplicate name or failed persistence.

pub fn create_with_doc_ticket( &mut self, name: &str, options: NetworkOptions, doc_ticket: Option<String>, ) -> Result<NetworkId>

Create a network with an optional membership doc ticket.

Errors

Returns an error for an empty/duplicate name or failed persistence.

pub fn join(&mut self, ticket: NetworkTicket) -> Result<NetworkId>

Join and persist the network represented by a ticket.

Errors

Returns an error if the ticket is for another device or persistence fails.

pub fn leave(&mut self, id: NetworkId) -> Result<()>

Leave a network and remove its local state.

Errors

Returns an error if the network does not exist or persistence fails.

pub fn invite( &mut self, id: NetworkId, device: PublicKey, ) -> Result<NetworkTicket>

Generate a device-bound invitation and add the device as a member.

Errors

Returns an error if the network does not exist, the local node is not its owner, or persistence fails.

pub fn invite_any(&self, id: NetworkId) -> Result<NetworkTicket>

Generate an invitation usable by any device.

Errors

Returns an error if the network does not exist or the local node is not its owner.

pub fn kick(&mut self, id: NetworkId, device: &PublicKey) -> Result<()>

Remove a member from a locally owned network.

Errors

Returns an error if the network does not exist, authorization fails, the owner is targeted, or persistence fails.

pub fn set_doc_ticket( &mut self, id: NetworkId, doc_ticket: &Option<String>, ) -> Result<()>

Set (or clear) the membership-doc ticket on a network.

Errors

Returns an error if the network does not exist or persistence fails.

pub fn add_folder(&mut self, id: NetworkId, folder: NamespaceId) -> Result<()>

Associate a folder with a network.

Errors

Returns an error if the network does not exist or persistence fails.

pub fn remove_folder( &mut self, id: NetworkId, folder: NamespaceId, ) -> Result<()>

Remove a folder association without changing the folder itself.

Errors

Returns an error if the network does not exist or persistence fails.

pub fn list(&self) -> Vec<&Network>

pub fn get(&self, id: &NetworkId) -> Option<&Network>

pub fn get_by_name(&self, name: &str) -> Option<&Network>

pub fn networks_for_folder( &self, namespace_id: &NamespaceId, ) -> Result<Vec<String>>

Return the network IDs (as strings) that contain a given folder.

Errors

Returns an error if the database query fails.

pub fn network_for_folder( &self, namespace_id: &NamespaceId, ) -> Result<Option<String>>

Return the first network ID that contains a given folder, if any.

Errors

Returns an error if the database query fails.

pub fn folders_for_network( &self, network_id: &NetworkId, ) -> Result<Vec<NamespaceId>>

List all folder namespace IDs associated with a network.

Errors

Returns an error if the database query fails.

pub fn members_of_network( &self, network_id: &NetworkId, ) -> Result<Vec<PublicKey>>

List all members of a network.

Errors

Returns an error if the database query fails.

Trait Implementations

impl Clone for NetworkManager

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkManager

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

Formats the value using the given formatter.