Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Runtime-validated, low-level builder for Client.

Unlike crate::bot::BotBuilder, this builder deliberately does not use typestate. FFI and embedded hosts can populate dependencies dynamically and receive a typed error without encoding Rust generic state in their wrapper.

Implementations

impl ClientBuilder

pub fn new() -> Self

Create an empty builder. All four platform dependencies are required.

pub fn with_runtime<R>(self, runtime: R) -> Self

where R: Runtime,

pub fn with_runtime_arc(self, runtime: Arc<dyn Runtime>) -> Self

pub fn with_persistence_manager( self, persistence_manager: Arc<PersistenceManager>, ) -> Self

pub fn with_transport_factory<T>(self, transport_factory: T) -> Self

where T: TransportFactory + 'static,

pub fn with_transport_factory_arc( self, transport_factory: Arc<dyn TransportFactory>, ) -> Self

pub fn with_http_client<H>(self, http_client: H) -> Self

where H: HttpClient + 'static,

pub fn with_http_client_arc(self, http_client: Arc<dyn HttpClient>) -> Self

pub fn with_version_override(self, version: (u32, u32, u32)) -> Self

pub fn with_cache_config(self, cache_config: CacheConfig) -> Self

pub fn with_enc_handler<H>( self, payload_type: impl Into<String>, handler: H, ) -> Self

where H: EncHandler + 'static,

Register a handler for one encrypted payload type before the client starts.

pub fn with_enc_handler_arc( self, payload_type: impl Into<String>, handler: Arc<dyn EncHandler>, ) -> Self

Register an already-shared encrypted payload handler.

pub fn with_inbound_durability_hook<H>(self, hook: H) -> Self

where H: InboundDurabilityHook + 'static,

Install the durable-inbound hook after verifying backend support.

pub fn with_inbound_durability_hook_arc( self, hook: Arc<dyn InboundDurabilityHook>, ) -> Self

Install an already-shared durable-inbound hook.

pub fn with_skip_history_sync(self, skip: bool) -> Self

pub fn with_wanted_pre_key_count(self, count: usize) -> Self

pub fn with_resend_rate_limit(self, burst: u32, refill_per_min: u32) -> Self

pub fn with_task_instrument(self, instrument: Arc<dyn TaskInstrument>) -> Self

Instrument every task spawned through the configured runtime.

pub fn with_alloc_meter(self, meter: Arc<AllocMeter>) -> Self

Install allocation attribution as the task instrument.

pub fn with_background_saver_interval(self, interval: Duration) -> Self

Run periodic device persistence for the lifetime of the client.

pub fn with_lifecycle<L>(self, lifecycle: L) -> Self

where L: ClientLifecycle + 'static,

Available on crate feature client-lifecycle only.

Install the aggregate lifecycle used by extensions of this client.

pub fn with_lifecycle_arc(self, lifecycle: Arc<dyn ClientLifecycle>) -> Self

Available on crate feature client-lifecycle only.

Install an already-shared aggregate lifecycle.

pub fn with_plugin<P: ClientPlugin>(self, plugin: P) -> Self

Available on crate feature plugins only.

Register a native plugin for transactional installation before services start.

pub fn with_plugin_arc<P: ClientPlugin>(self, plugin: Arc<P>) -> Self

Available on crate feature plugins only.

Register an already-shared native plugin without changing its marker type.

pub fn with_untyped_plugin<P: UntypedClientPlugin>(self, plugin: P) -> Self

Available on crate feature plugins only.

Register a manifest-ID-keyed plugin that exposes no Rust typed API.

pub fn with_untyped_plugin_arc<P: UntypedClientPlugin + ?Sized>( self, plugin: Arc<P>, ) -> Self

Available on crate feature plugins only.

Register an already-shared manifest-ID-keyed plugin.

pub fn with_plugin_host_config(self, config: PluginHostConfig) -> Self

Available on crate feature plugins only.

Configure plugin lifecycle and tracked-task deadlines.

pub async fn build(self) -> Result<ClientBuild, ClientBuilderError>

Validate dependencies, assemble an inert client, then start its services.

Trait Implementations

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.