Enum catenis_api_client::ClientOptions

pub enum ClientOptions<'a> {
    Host(&'a str),
    Environment(Environment),
    Secure(bool),
    Version(ApiVersion),
    UseCompression(bool),
    CompressThreshold(usize),
}

Option settings that can be used when instantiating the Catenis API client.

Variants

Host(&'a str)

Host name (with optional port) of target Catenis API server. Default value: "catenis.io".

Tuple Fields of Host

0: &'a str

Environment(Environment)

Environment of target Catenis API server. Default value: Environment::Prod.

Tuple Fields of Environment

0: Environment

Secure(bool)

Indicates whether a secure connection (HTTPS) should be used. Default value: true.

Tuple Fields of Secure

0: bool

Version(ApiVersion)

Version of Catenis API to target. Default value: ApiVersion(11, 0).

Tuple Fields of Version

0: ApiVersion

UseCompression(bool)

Indicates whether request body should be compressed. Default value: true.

Tuple Fields of UseCompression

0: bool

CompressThreshold(usize)

Minimum size, in bytes, of request body for it to be compressed. Default value: 1024.

Tuple Fields of CompressThreshold

0: usize

Trait Implementations

impl<'a> Clone for ClientOptions<'a>

fn clone(&self) -> ClientOptions<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ClientOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for ClientOptions<'a>