Struct Client

pub struct Client { /* private fields */ }

Implementations

impl<'a> Client

pub fn account(&'a self) -> AccountClient<'a>

Returns a wrapping client for the account API.

impl<'a> Client

pub fn domain(&'a self) -> DomainClient<'a>

Returns a wrapping client for the domain API.

impl<'a> Client

pub fn rrset(&'a self) -> RrsetClient<'a>

Returns a wrapping client for the Resource Record Sets (RRsets) API.

impl<'a> Client

pub fn token(&'a self) -> TokenClient<'a>

Returns a wrapping client for the token API.

impl Client

pub fn new(token: String) -> Result<Self, Error>

Creates a new client using the given API token.

Errors

This method fails with Error::ReqwestClientBuilder if the underlying reqwest::ClientBuilder fails to build a http client.

pub async fn new_from_credentials( email: &str, password: &str, ) -> Result<Self, Error>

Creates a new client using the given credentials.

Errors

This method fails with Error::ReqwestClientBuilder if the underlying reqwest::ClientBuilder fails to build a http client.

pub async fn logout(self) -> Result<(), Error>

Consume and logout the authenticated client.

Attention: this assumes that the client has been authenticated using credentials. Trying to logout a client created from a token will return Error::CannotLogout.

Errors

This method fails with:

• Error::CannotLogout if the client was not created from credentials
• Error::UnexpectedStatusCode if the API responds with an undocumented status code
• Error::Reqwest if the whole request failed

pub fn set_retry(&mut self, retry: bool)

Sets whether retries are enabled.

pub fn get_retry(&self) -> &bool

Returns whether retries are enabled.

pub fn set_max_wait_retry(&mut self, max_wait_retry: u64)

Sets the maximum wait time for a single retry

pub fn get_max_wait_retry(&self) -> &u64

Returns the maximum wait time for a single retry

pub fn set_max_retries(&mut self, max_retries: usize)

Sets the maximum number of retries

pub fn get_max_retries(&self) -> &usize

Returns the maximum number of retries

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.