Struct Config 

pub struct Config {
    pub email: Option<String>,
    pub proxy: Option<String>,
    pub default_rows: u32,
    pub cache_ttl_days: u32,
    pub cache_dir: Option<String>,
}

Runtime configuration resolved from (in priority order):

1. CLI flags / function arguments
2. Environment variables (CROSSREF_EMAIL, CROSSREF_PROXY, …)
3. Config file (~/.config/crossref.toml or --config path)
4. Built-in defaults

Fields

email: Option<String>

Email for Crossref polite-pool access (required for well-behaved usage).

proxy: Option<String>

EZproxy host, e.g. doi-org.ezproxy.cityu.edu.hk.

default_rows: u32

Default number of rows returned by crossref search.

cache_ttl_days: u32

Cache time-to-live in days.

cache_dir: Option<String>

Override the default XDG cache directory.

Implementations

impl Config

pub fn load( email_override: Option<&str>, config_path: Option<&str>, ) -> Result<Self>

Load configuration by merging (CLI override > env vars > config file > defaults). email_override and config_path come from CLI flags.

pub fn load_with_guidance( email_override: Option<&str>, config_path: Option<&str>, ) -> Result<Option<Self>>

Like Config::load but also handles first-run guidance for the CLI binary. Returns None when guidance was printed and the caller should exit.

pub fn has_email(&self) -> bool

Returns true when a polite email address is configured.

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() -> Self

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.