Struct Config 

#[non_exhaustive]
pub struct Config {
    pub base_url: String,
    pub account: Option<String>,
    pub cache_dir: PathBuf,
    pub cache_enabled: bool,
}

What a client needs to know before it can talk to Fizzy.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

base_url: String

The API origin: https://fizzy.do, or a Fizzy running on this machine.

account: Option<String>

The account most calls are scoped to, when there is a usual one.

cache_dir: PathBuf

Where the response cache keeps its files.

cache_enabled: bool

Whether reads are cached by ETag.

Implementations

impl Config

pub fn new() -> Config

The defaults.

pub fn with_env(self) -> Config

Lets FIZZY_API_URL, FIZZY_ACCOUNT, FIZZY_CACHE_DIR and FIZZY_CACHE_ENABLED override whatever is set, the same variables the Go SDK reads. An empty variable counts as unset.

pub fn with_base_url(self, base_url: impl Into<String>) -> Config

Points the client somewhere other than https://fizzy.do.

pub fn with_account(self, account: impl Into<String>) -> Config

Names the usual account.

pub fn with_cache_enabled(self, enabled: bool) -> Config

Turns the ETag cache on or off.

pub fn with_cache_dir(self, cache_dir: impl Into<PathBuf>) -> Config

Moves the cache directory.

pub fn origin(&self) -> &str

The base URL without a trailing slash.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

where Config: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Config

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config