Lines
79.07 %
Functions
33.33 %
Branches
100 %
use std::{collections::HashMap, sync::Arc};
use bonsaidb_core::{api, networking::CURRENT_PROTOCOL_VERSION, schema::ApiName};
#[cfg(not(target_arch = "wasm32"))]
use fabruic::Certificate;
use tokio::runtime::Handle;
use url::Url;
use crate::{
client::{AnyApiCallback, ApiCallback},
Client, Error,
};
/// Builds a new [`Client`] with custom settings.
#[must_use]
pub struct Builder {
url: Url,
protocol_version: &'static str,
custom_apis: HashMap<ApiName, Option<Arc<dyn AnyApiCallback>>>,
certificate: Option<fabruic::Certificate>,
tokio: Option<Handle>,
}
impl Builder {
/// 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(),
certificate: None,
tokio: Handle::try_current().ok(),
/// 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;
/// Finishes building the client.
pub fn finish(self) -> Result<Client, Error> {
Client::new_from_parts(
self.url,
self.protocol_version,
self.custom_apis,
self.certificate,
self.tokio,
)