Struct bonsaidb::client::Builder

source · [−]

pub struct Builder<A = ()> where
    A: CustomApi,  { /* private fields */ }

Expand description

Builds a new Client with custom settings.

Implementations

source

impl Builder<()>

source

pub fn with_custom_api<A>(self) -> Builder<A> where
A: CustomApi,

Enables using a CustomApi 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_custom_api_callback<A, C>(self, callback: C) -> Builder<A> where
A: CustomApi,
C: CustomApiCallback<A>,

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

source

impl<A> Builder<A> where
A: CustomApi,

source

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

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<A>

Overrides the protocol version. Only for testing purposes.

source

pub async fn finish(self) -> Result<Client<A>, Error<<A as CustomApi>::Error>>

Finishes building the client.

Auto Trait Implementations

impl<A = ()> !RefUnwindSafe for Builder<A>

impl<A> Send for Builder<A>

impl<A> Sync for Builder<A>

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

impl<A = ()> !UnwindSafe for Builder<A>

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T> Instrument for T

source

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

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

source

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 for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct bonsaidb::client::Builder

Implementations

impl Builder<()>

pub fn with_custom_api<A>(self) -> Builder<A> where A: CustomApi,

pub fn with_custom_api_callback<A, C>(self, callback: C) -> Builder<A> where A: CustomApi, C: CustomApiCallback<A>,

impl<A> Builder<A> where A: CustomApi,

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

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

pub async fn finish(self) -> Result<Client<A>, Error<<A as CustomApi>::Error>>

Auto Trait Implementations

impl<A = ()> !RefUnwindSafe for Builder<A>

impl<A> Send for Builder<A>

impl<A> Sync for Builder<A>

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

impl<A = ()> !UnwindSafe for Builder<A>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn with_custom_api<A>(self) -> Builder<A> where
A: CustomApi,

pub fn with_custom_api_callback<A, C>(self, callback: C) -> Builder<A> where
A: CustomApi,
C: CustomApiCallback<A>,

impl<A> Builder<A> where
A: CustomApi,

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

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

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

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

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

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

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

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

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