Struct ClientBuilder 

pub struct ClientBuilder<ApiClient, S, Db = DefaultStore> { /* private fields */ }

Implementations

impl<ApiClient, S, Db> ClientBuilder<ApiClient, S, Db>

pub fn new(identity_strategy: IdentityStrategy) -> Self

impl<ApiClient, S, Db> ClientBuilder<ApiClient, S, Db>

pub fn build_offline( self, ) -> Result<Client<Arc<XmtpMlsLocalContext<ApiClient, Db, S>>>, ClientBuilderError>

where ApiClient: XmtpApi + 'static, Db: XmtpDb + 'static, S: XmtpMlsStorageProvider + 'static,

build a client in offline mode. returns an error if the client failed to build as offline

pub async fn build( self, ) -> Result<Client<Arc<XmtpMlsLocalContext<ApiClient, Db, S>>>, ClientBuilderError>

where ApiClient: XmtpApi + 'static, Db: XmtpDb + 'static, S: XmtpMlsStorageProvider + 'static,

pub fn identity(self, identity: Identity) -> Self

pub fn attachments_dir(self, path: impl Into<PathBuf>) -> Self

pub fn attachment_options(self, options: AttachmentOptions) -> Self

pub async fn data_location( self, location: StorageLocation, key: EncryptionKey, ) -> Result<ClientBuilder<ApiClient, S, DefaultStore>, ClientBuilderError>

Save a deployment-scoped location. build resolves it after all options are set.

pub fn data_location_with<NewDb>( self, location: StorageLocation, opener: impl FnOnce(ResolvedPaths) -> BoxDynFuture<'static, Result<NewDb, ClientBuilderError>> + MaybeSend + MaybeSync + 'static, ) -> Result<ClientBuilder<ApiClient, S, NewDb>, ClientBuilderError>

Save a deployment-scoped location that opener opens. build resolves the paths after all options are set and passes them to opener, so a host can open the store with its own connection options.

pub fn unstable_change_callbacks( self, change_callbacks: UnstableChangeCallbacks, ) -> Self

Unstable: register callbacks notified when group state changes.

Registration is construction-time by necessity — the changes these report arrive from the stream and sync paths, where no SDK call is on the stack. Passing UnstableChangeCallbacks::default (nothing set) is equivalent to not calling this at all.

See crate::groups::change_callbacks for the delivery contract.

pub fn store<NewDb>(self, db: NewDb) -> ClientBuilder<ApiClient, S, NewDb>

pub fn default_mls_store( self, ) -> Result<ClientBuilder<ApiClient, SqlKeyStore<<Db as XmtpDb>::DbQuery>, Db>, ClientBuilderError>

where Db: XmtpDb,

Use the default SQlite MLS Key-Value Store

pub fn mls_storage<NewS>( self, mls_storage: NewS, ) -> ClientBuilder<ApiClient, NewS, Db>

pub fn with_disable_workers(self, disable_workers: bool) -> Self

pub fn with_device_sync_worker_mode(self, mode: Option<DeviceSyncMode>) -> Self

pub fn device_sync_worker_mode(self, mode: DeviceSyncMode) -> Self

pub fn fork_recovery_opts(self, opts: ForkRecoveryOpts) -> Self

pub fn worker_config(self, cfg: WorkerConfig) -> Self

Configure background-worker intervals, jitter, and per-worker enablement. See crate::worker::WorkerConfig.

pub fn config_provider(self, provider: Arc<dyn ConfigProvider>) -> Self

Supply the server configuration instead of reading it.

With a provider in place the client does not fetch, store, or refresh the configuration. A data directory still checks its deployment identifier. Rust callers only; the bindings do not expose this.

pub fn api_client<A>(self, api_client: A) -> ClientBuilder<A, S, Db>

Attach a query-only API client. Receipt uses ordered Query pages. Standard streaming clients use api_client_with_streams at construction.

pub fn api_client_with_streams<A>( self, api_client: A, ) -> ClientBuilder<A, S, Db>

where A: XmtpMlsBidiStreams + ApiClientIdentity + Clone + Send + Sync + 'static, A::SubscribeStream: 'static,

Attach a native API client with a lazy shared Bidi receiver. No transport task or connection starts until the first receiving interest.

pub fn maybe_version( self, version: Option<VersionInfo>, ) -> ClientBuilder<ApiClient, S, Db>

pub fn version( self, version_info: VersionInfo, ) -> ClientBuilder<ApiClient, S, Db>

pub fn with_allow_offline( self, allow_offline: Option<bool>, ) -> ClientBuilder<ApiClient, S, Db>

Skip network calls when building a client

pub fn require_identifier_in_inbox(self) -> Self

Require the identity strategy’s identifier to belong to the inbox of the identity the build loads, including a stored one. The build checks the association state after it loads the inbox’s identity updates and before it starts any worker. Before the inbox’s first identity update, only the identifier whose inbox at the strategy’s nonce is that inbox belongs to it. A failure is IdentityError::IdentifierNotInInbox.

pub fn enable_api_stats( self, ) -> Result<ClientBuilder<TrackedStatsClient<ApiClient>, S, Db>, ClientBuilderError>

pub fn with_scw_verifier( self, verifier: impl SmartContractSignatureVerifier + 'static, ) -> ClientBuilder<ApiClient, S, Db>

pub fn with_remote_verifier( self, ) -> Result<ClientBuilder<ApiClient, S, Db>, ClientBuilderError>

where ApiClient: Clone + XmtpApi + 'static,

Build the client with a default remote verifier requires the ‘api’ to be set.