Struct bonsaidb::client::Builder

source ·
pub struct Builder<AsyncMode> { /* private fields */ }
Expand description

Builder for a BlockingClient or an AsyncClient.

Implementations§

source§

impl<AsyncMode> Builder<AsyncMode>

source

pub fn with_runtime(self, handle: Handle) -> Builder<AsyncMode>

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().

source

pub fn with_api<Api>(self) -> Builder<AsyncMode>
where Api: Api,

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.

source

pub fn with_api_callback<Api>( self, callback: ApiCallback<Api> ) -> Builder<AsyncMode>
where Api: Api,

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

source

pub fn with_certificate(self, certificate: Certificate) -> Builder<AsyncMode>

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

source

pub fn with_protocol_version(self, version: &'static str) -> Builder<AsyncMode>

Overrides the protocol version. Only for testing purposes.

source

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

Sets the request timeout for the client.

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

source

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

Sets the connection timeout for the client.

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

source§

impl Builder<Blocking>

source

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

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

source§

impl Builder<Async>

source

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

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

Auto Trait Implementations§

§

impl<AsyncMode> !RefUnwindSafe for Builder<AsyncMode>

§

impl<AsyncMode> Send for Builder<AsyncMode>
where AsyncMode: Send,

§

impl<AsyncMode> Sync for Builder<AsyncMode>
where AsyncMode: Sync,

§

impl<AsyncMode> Unpin for Builder<AsyncMode>
where AsyncMode: Unpin,

§

impl<AsyncMode> !UnwindSafe for Builder<AsyncMode>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more