Struct SharedConfigBuilder

pub struct SharedConfigBuilder {
    pub stripe_version: ApiVersion,
    pub app_info_str: Option<String>,
    pub client_id: Option<ApplicationId>,
    pub account_id: Option<AccountId>,
    pub request_strategy: Option<RequestStrategy>,
    pub secret: String,
    pub api_base: Option<String>,
}

Shared configuration utilities for implementing a Stripe client.

This is meant for internal use when implementing compatible clients, so it may be more unstable with respect to semver.

Fields

stripe_version: ApiVersion

The stripe version being used.

app_info_str: Option<String>

The user-provided part of the user-agent we’ll use.

client_id: Option<ApplicationId>

The client id to send requests with.

account_id: Option<AccountId>

The account id to send requests with.

request_strategy: Option<RequestStrategy>

The default request strategy to use.,

secret: String

The secret key for authorizing requests.

api_base: Option<String>

The base URL to send requests to.

Implementations

impl SharedConfigBuilder

pub fn new(secret: impl Into<String>) -> Self

Create a new SharedConfigBuilder with the given secret key.

pub fn client_id(self, client_id: ApplicationId) -> Self

Set the Stripe client id for the client. This will be sent to stripe with the “client-id” header.

pub fn account_id(self, account_id: AccountId) -> Self

Set the default Stripe account id used for the client. This will be sent to stripe with the “stripe-account” header, unless it is overridden when customizing a request.

pub fn request_strategy(self, strategy: RequestStrategy) -> Self

Sets the default RequestStrategy used when making requests.

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

Create a new client pointed at a specific URL. This is useful for testing.

pub fn app_info( self, name: impl Into<String>, version: Option<String>, url: Option<String>, ) -> Self

Set the application info for the client.

Trait Implementations

impl Clone for SharedConfigBuilder

fn clone(&self) -> SharedConfigBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SharedConfigBuilder

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

Formats the value using the given formatter.