Struct BrowserCookieReadOptions 

pub struct BrowserCookieReadOptions {

    pub browser: String,
    pub profile: Option<String>,
    pub profile_dir: Option<PathBuf>,
    pub domain_filter: Option<String>,
    pub cache: bool,
    pub cache_dir: Option<PathBuf>,
    pub ttl_minutes: Option<f64>,
    pub refresh: bool,
    pub ignore_decryption_errors: bool,
    pub home_dir: PathBuf,
    pub platform: String,
    pub environment: Environment,
    pub run_command: Option<RunCommand>,
}

Options for read_browser_cookies.

Fields

browser: String

Installed browser name, or default/auto for the system default.

profile: Option<String>

Optional on-disk or display profile name.

profile_dir: Option<PathBuf>

Explicit profile directory. When set, the reader uses it directly instead of resolving the default profile location (for example a migration honouring a custom userDataDir).

domain_filter: Option<String>

Optional domain substring used by the SQLite query.

cache: bool

Enable the owner-only decrypted-result and derived-key cache.

cache_dir: Option<PathBuf>

Override the cache directory.

ttl_minutes: Option<f64>

Cache lifetime in minutes.

refresh: bool

Bypass cached values and coordinate one refreshed credential read.

ignore_decryption_errors: bool

Skip individual cookies that cannot be decrypted.

home_dir: PathBuf

Home directory used for profile discovery and the default cache.

platform: String

Platform convention (linux, darwin, or win32).

environment: Environment

Environment used to expand profile-root templates (%APPDATA%, …).

run_command: Option<RunCommand>

Command runner used to resolve the system default browser, injectable for deterministic tests. None uses a real subprocess.

Implementations

impl BrowserCookieReadOptions

pub fn new(browser: impl Into<String>) -> Self

Create options for one installed browser.

pub fn profile(self, profile: impl Into<String>) -> Self

Select a named installed-browser profile.

pub fn profile_dir(self, profile_dir: impl Into<PathBuf>) -> Self

Read from an explicit profile directory instead of resolving the default profile location for the browser.

pub fn environment(self, environment: Environment) -> Self

Override the environment used when expanding profile-root templates.

pub fn run_command(self, run_command: RunCommand) -> Self

Inject the command runner used to resolve the system default browser.

pub fn domain_filter(self, domain: impl Into<String>) -> Self

Restrict the SQLite query to domains containing this value.

pub fn cache(self, enabled: bool) -> Self

Enable or disable disk caching.

pub fn cache_dir(self, directory: impl Into<PathBuf>) -> Self

Override the owner-only cache directory.

pub fn ttl_minutes(self, minutes: f64) -> Self

Set the decrypted-result and derived-key cache TTL.

pub fn refresh(self, refresh: bool) -> Self

Force a coordinated refresh of cached results and credentials.

pub fn ignore_decryption_errors(self, ignore: bool) -> Self

Skip cookies whose platform decryption fails.

pub fn home_dir(self, home_dir: impl Into<PathBuf>) -> Self

Override the home directory used for discovery.

pub fn platform(self, platform: impl AsRef<str>) -> Self

Override the platform convention, primarily for portable tooling/tests.

Trait Implementations

impl Clone for BrowserCookieReadOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BrowserCookieReadOptions

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

Formats the value using the given formatter.