Struct Client 

pub struct Client { /* private fields */ }

The pdns api client for a single pdns webserver. It should be created with the Client::new or Client::new_with_client function.

Implementations

impl Client

pub fn list_servers(&self) -> Result<Vec<Server>>

list the servers

Errors

• super::Error::Url if the api endpoint url could not be formed
• super::Error::Http if errors in making request
• super::Error::Http if errors in decoding response JSON on a successful request
• super::Error::APIError if api returned an error (not 200 OK status)

pub fn list_server(&self, server_id: &str) -> Result<Server>

lists information on a specific server

Errors

• super::Error::Url if the api endpoint url could not be formed
• super::Error::Http if errors in making request
• super::Error::Http if errors in decoding response JSON on a successful request
• super::Error::APIError if api returned an error (not 200 OK status)

impl Client

pub fn new(base_url: impl AsRef<str>, api_key: &str) -> Result<Self>

creates a new Client. api_key is the value for the X-API-Key header base_url should be a valid base url with no path (it will be joined with /api/v1 which will clear its path)

The underlying client uses the defaults of a reqwest::blocking::Client Use Client::new_with_client instead to specify the internal client

Errors

• Error::InvalidBaseUrl if base_url is not a valid base url
• Error::InvalidBaseUrl if scheme is not http, https
• Error::BadApiKey if api_key is not a valid header value
• Error::Http if the internal client could not be made
• Error::Url if base_url could not be parsed

pub fn new_with_client( base_url: impl AsRef<str>, client: Client, ) -> Result<Self>

creates a new Client. client is the underlying client to use base_url should be a valid base url with no path (it will be joined with /api/v1 which will clear its path) It is assumed that client has a default header for (“X-API-Key”, “api key”) for authentication

Errors

• Error::Url if base_url could not be parsed
• Error::InvalidBaseUrl if base_url is not a valid base url
• Error::InvalidBaseUrl if scheme is not http, https

pub fn base_url(&self) -> &Url

returns the configured base url

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate 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.

impl Display for Client

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

Formats the value using the given formatter.