Struct bonsaidb_client::Builder

pub struct Builder<AsyncMode> { /* private fields */ }

Builder for a BlockingClient or an AsyncClient.

Implementations

impl<AsyncMode> Builder<AsyncMode>

pub fn with_runtime(self, handle: Handle) -> Self

Specifies the tokio runtime this client should use for its async tasks. If not specified, Client will try to acquire a handle via tokio::runtime::Handle::try_current().

pub fn with_api<Api: Api>(self) -> Self

Enables using a Api with this client. If you want to receive out-of-band API requests, set a callback using with_custom_api_callback instead.

pub fn with_api_callback<Api: Api>(self, callback: ApiCallback<Api>) -> Self

Enables using a Api with this client. callback will be invoked when custom API responses are received from the server.

pub fn with_certificate(self, certificate: Certificate) -> Self

Connects to a server using a pinned certificate. Only supported with BonsaiDb protocol-based connections.

pub fn with_protocol_version(self, version: &'static str) -> Self

Overrides the protocol version. Only for testing purposes.

pub fn with_request_timeout(self, timeout: impl Into<Duration>) -> Self

Sets the request timeout for the client.

If not specified, requests will time out after 60 seconds.

pub fn with_connect_timeout(self, timeout: impl Into<Duration>) -> Self

Sets the connection timeout for the client.

If not specified, the client will time out after 60 seconds if a connection cannot be established.

impl Builder<Blocking>

pub fn build(self) -> Result<BlockingClient, Error>

Finishes building the client for use in a blocking (not async) context.

impl Builder<Async>

pub fn build(self) -> Result<AsyncClient, Error>

Finishes building the client for use in a tokio async context.