Lines
85.48 %
Functions
56.52 %
Branches
100 %
use std::collections::HashMap;
use std::marker::PhantomData;
use std::sync::Arc;
use std::time::Duration;
use bonsaidb_core::api;
use bonsaidb_core::api::ApiName;
use bonsaidb_core::networking::CURRENT_PROTOCOL_VERSION;
#[cfg(not(target_arch = "wasm32"))]
use fabruic::Certificate;
use tokio::runtime::Handle;
use url::Url;
use crate::client::{AnyApiCallback, ApiCallback};
use crate::BlockingClient;
use crate::{AsyncClient, Error};
/// A type marker for [`Builder`] indicating the returned client should be an
/// [`AsyncClient`].
pub struct Async;
/// [`BlockingClient`].
pub struct Blocking;
/// Builder for a [`BlockingClient`] or an [`AsyncClient`].
#[must_use]
pub struct Builder<AsyncMode> {
url: Url,
protocol_version: &'static str,
custom_apis: HashMap<ApiName, Option<Arc<dyn AnyApiCallback>>>,
connect_timeout: Option<Duration>,
request_timeout: Option<Duration>,
certificate: Option<fabruic::Certificate>,
tokio: Option<Handle>,
mode: PhantomData<AsyncMode>,
}
impl<AsyncMode> Builder<AsyncMode> {
/// Creates a new builder for a client connecting to `url`.
pub(crate) fn new(url: Url) -> Self {
Self {
url,
protocol_version: CURRENT_PROTOCOL_VERSION,
custom_apis: HashMap::new(),
request_timeout: None,
connect_timeout: None,
certificate: None,
tokio: None,
mode: PhantomData,
/// 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()`.
#[allow(clippy::missing_const_for_fn)]
pub fn with_runtime(mut self, handle: Handle) -> Self {
self.tokio = Some(handle);
self
/// Enables using a [`Api`](api::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<Api: api::Api>(mut self) -> Self {
self.custom_apis.insert(Api::name(), None);
/// Enables using a [`Api`](api::Api) with this client. `callback` will be
/// invoked when custom API responses are received from the server.
pub fn with_api_callback<Api: api::Api>(mut self, callback: ApiCallback<Api>) -> Self {
self.custom_apis
.insert(Api::name(), Some(Arc::new(callback)));
/// Connects to a server using a pinned `certificate`. Only supported with BonsaiDb protocol-based connections.
pub fn with_certificate(mut self, certificate: Certificate) -> Self {
self.certificate = Some(certificate);
/// Overrides the protocol version. Only for testing purposes.
#[cfg(feature = "test-util")]
pub fn with_protocol_version(mut self, version: &'static str) -> Self {
self.protocol_version = version;
/// Sets the request timeout for the client.
///
/// If not specified, requests will time out after 60 seconds.
pub fn with_request_timeout(mut self, timeout: impl Into<Duration>) -> Self {
self.request_timeout = Some(timeout.into());
/// Sets the connection timeout for the client.
/// If not specified, the client will time out after 60 seconds if a
/// connection cannot be established.
pub fn with_connect_timeout(mut self, timeout: impl Into<Duration>) -> Self {
self.connect_timeout = Some(timeout.into());
fn finish_internal(self) -> Result<AsyncClient, Error> {
AsyncClient::new_from_parts(
self.url,
self.protocol_version,
self.custom_apis,
self.connect_timeout,
self.request_timeout,
self.certificate,
self.tokio.or_else(|| Handle::try_current().ok()),
)
impl Builder<Blocking> {
/// Finishes building the client for use in a blocking (not async) context.
pub fn build(self) -> Result<BlockingClient, Error> {
self.finish_internal().map(BlockingClient)
impl Builder<Async> {
/// Finishes building the client for use in a tokio async context.
pub fn build(self) -> Result<AsyncClient, Error> {
self.finish_internal()