Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Used to configure, assemble and build Client

Implementations

impl ClientBuilder

pub fn with_module_inits(&mut self, module_inits: ClientModuleInitRegistry)

Replace module generator registry entirely

pub fn with_module<M: ClientModuleInit>(&mut self, module_init: M)

Make module generator available when reading the config

pub fn stopped(&mut self)

pub fn with_api_request_hook(self, hook: ApiRequestHook) -> Self

Build the Client with a custom wrapper around its api request logic

This is intended to be used by downstream applications, e.g. to:

• simulate offline mode,
• save battery when the OS indicates lack of connectivity,
• inject faults and delays for testing purposes,
• collect statistics and emit notifications.

pub fn with_meta_service(&mut self, meta_service: Arc<MetaService>)

pub fn with_iroh_enable_dht(self, iroh_enable_dht: bool) -> Self

Override if the DHT should be enabled when using Iroh to connect to the federation

pub fn with_iroh_enable_next(self, iroh_enable_next: bool) -> Self

Override if the parallel unstable/next Iroh stack should be enabled when using Iroh to connect to the federation

pub async fn load_existing_config(&self, db: &Database) -> Result<ClientConfig>

pub fn set_admin_creds(&mut self, creds: AdminCreds)

pub async fn preview( self, connectors: ConnectorRegistry, invite_code: &InviteCode, ) -> Result<ClientPreview>

pub async fn preview_with_existing_config( self, connectors: ConnectorRegistry, config: ClientConfig, api_secret: Option<String>, ) -> Result<ClientPreview>

Use Self::preview instead

If reuse_api is set, it will allow the preview to prefetch some data to speed up the final join.

pub async fn open( self, connectors: ConnectorRegistry, db_no_decoders: Database, pre_root_secret: RootSecret, ) -> Result<ClientHandle>

pub fn get_event_log_transient_receiver(&self) -> Receiver<EventLogEntry>

Register to receiver all new transient (unpersisted) events