Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Configures and builds a Client.

use oanda_rs::{Client, Environment};
use oanda_rs::models::AcceptDatetimeFormat;

let client = Client::builder()
    .environment(Environment::Practice)
    .token("my-token")
    .datetime_format(AcceptDatetimeFormat::Unix)
    .rest_rate_limit(50)
    .build()
    .unwrap();

Implementations

impl ClientBuilder

pub fn environment(self, environment: Environment) -> Self

Selects the OANDA environment. Defaults to Environment::Practice.

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

Sets the personal access token used as the bearer token on every request. Required.

pub fn datetime_format(self, format: AcceptDatetimeFormat) -> Self

Selects the datetime wire format requested via the Accept-Datetime-Format header. Defaults to AcceptDatetimeFormat::Rfc3339.

pub fn http_client(self, http: Client) -> Self

Supplies a pre-configured reqwest::Client (proxies, timeouts, custom TLS). When set, ClientBuilder::user_agent is ignored.

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

Overrides the User-Agent header of the default HTTP client. Defaults to oanda-rs/<version>.

pub fn rest_rate_limit(self, requests_per_second: u32) -> Self

Sets the client-side REST rate limit in requests per second. Defaults to 100 (OANDA rejects above 120/s per IP).

Note that OANDA’s limits apply per IP address: if several processes or Client instances share one IP, their combined rate matters. Within one process, share a single Client (it is cheap to clone).

pub fn rate_limiting(self, enabled: bool) -> Self

Enables or disables built-in rate limiting entirely (REST requests and stream connections). Enabled by default; disable only when you provide your own throttling.

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

Builds the Client.

Errors

Returns Error::Config when no token was provided, the token is empty, or the HTTP client cannot be constructed.

Trait Implementations

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.