Struct Config 

pub struct Config {
    pub base_url: String,
    pub oauth_client_id: String,
    pub cache_dir: PathBuf,
    pub cache_enabled: bool,
}

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

Fields

base_url: String

Where HEY is: DEFAULT_BASE_URL, or a HEY running on this machine.

oauth_client_id: String

The OAuth client to sign in as.

cache_dir: PathBuf

Where the response cache keeps its files.

cache_enabled: bool

Whether JSON reads are cached on disk between runs.

Implementations

impl Config

pub fn load(path: &Path) -> Result<Config, Error>

Reads a JSON config file over the defaults. A missing file answers the defaults.

pub fn with_env(self) -> Config

Lets HEY_BASE_URL, HEY_OAUTH_CLIENT_ID, HEY_CACHE_DIR and HEY_CACHE_ENABLED override whatever is set. An empty variable counts as unset.

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

Points the client at another HEY, such as one running on this machine.

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

Turns the on-disk response cache on or off.

pub fn origin(&self) -> &str

The base URL without a trailing slash: the key credentials are stored under.

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