Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

A builder for Client.

Construct one with Client::builder, set the credentials and the whitelisted client IP, then call build.

Implementations

impl ClientBuilder

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

Sets the API username (the ApiUser parameter).

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

Sets the API key (the ApiKey parameter).

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

Sets the account username (the UserName parameter).

When omitted, this defaults to the value of api_user. It only differs when acting on behalf of another account.

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

Sets the whitelisted client IP (the ClientIp parameter).

This must be the public IPv4 address you have whitelisted in the Namecheap API settings, and it must match the address the request actually originates from.

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

Selects the Environment. Defaults to Environment::Production.

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

Supplies a preconfigured reqwest::Client (custom timeouts, proxy, and so on). When omitted, a default client is created.

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

Builds the Client.

Errors

Returns Error::Configuration if api_user, api_key, or client_ip is missing, or if a default HTTP client could not be constructed.

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> ClientBuilder

Returns the “default value” for a type.