Struct ClientBuilder 

pub struct ClientBuilder(/* private fields */);

Builder to create a Client.

Implementations

impl ClientBuilder

pub fn new(service_url: impl IntoUrl) -> Self

Creates a new ClientBuilder, configured with the given service_url.

To perform CRUD operations, one has to create a Client, and then scope it to a Usecase and Scope in order to create a Session.

pub fn propagate_traces(self, propagate_traces: bool) -> Self

Changes whether the sentry-trace header will be sent to Objectstore to take advantage of Sentry’s distributed tracing.

By default, tracing headers will not be propagated.

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

Defines a read timeout for the [reqwest::Client].

The read timeout is defined to be “between consecutive read operations”, for example between chunks of a streaming response. For more fine-grained configuration of this and other timeouts, use Self::configure_reqwest.

By default, no read timeout and a connect timeout of 100ms is set.

pub fn configure_reqwest<F>(self, closure: F) -> Self

where F: FnOnce(ClientBuilder) -> ClientBuilder,

Calls the closure with the underlying [reqwest::ClientBuilder].

By default, the ClientBuilder is configured to create a reqwest Client with a connect and read timeout of 500ms and a user agent identifying this library.

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

Sets the authentication token to use for requests to Objectstore.

Accepts anything that implements Into<TokenProvider>:

• A TokenGenerator — for internal services that have access to an EdDSA keypair. The generator signs a fresh JWT for each request.
• A String or &str — a pre-signed JWT, used as-is for every request.

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

Returns a Client that uses this ClientBuilder configuration.

Errors

This method fails if:

• the given service_url is invalid or cannot be used as a base URL
• the [reqwest::Client] fails to build. Refer to [reqwest::ClientBuilder::build] for more information on when this can happen.

Trait Implementations

impl Debug for ClientBuilder

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

Formats the value using the given formatter.