Skip to main content

MarpleDBBuilder

Struct MarpleDBBuilder 

Source
#[non_exhaustive]
pub struct MarpleDBBuilder { /* private fields */ }
Expand description

Builder for MarpleDB.

Implementations§

Source§

impl MarpleDBBuilder

Source

pub fn url(self, url: impl Into<String>) -> Self

Sets the MarpleDB API base URL.

The URL should usually end in /api/v1.

Source

pub fn token(self, token: impl Into<String>) -> Self

Sets the bearer API token.

The token is sent as Authorization: Bearer <token> on API requests.

Source

pub fn timeout(self, timeout: Duration) -> Self

Sets the timeout for the API and storage HTTP clients built by the SDK.

This only affects clients created by the builder. Caller-provided clients keep their own timeout configuration.

Source

pub fn user_agent(self, user_agent: impl Into<String>) -> Self

Sets the user agent for HTTP clients built by the SDK.

Source

pub fn request_source(self, request_source: impl Into<String>) -> Self

Overrides the X-Request-Source header sent on every API request.

The default is sdk/rust:<crate-version>. Higher-level tools built on top of the SDK should identify themselves so their traffic shows up distinctly in backend logs and metrics, for example cli/rust:1.2.3 or my-ingester/2.0.0.

Source

pub fn client(self, client: Client) -> Self

Uses a caller-provided API HTTP client.

The SDK still attaches the MarpleDB authorization header per request.

Source

pub fn storage_client(self, client: Client) -> Self

Uses a caller-provided storage HTTP client.

This client is used for pre-signed direct storage URLs and should not include MarpleDB authorization headers by default.

Source

pub fn build(self) -> Result<MarpleDB>

Builds a configured MarpleDB client.

Trait Implementations§

Source§

impl Clone for MarpleDBBuilder

Source§

fn clone(&self) -> MarpleDBBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for MarpleDBBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for MarpleDBBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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

Source§

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