Struct Options 

pub struct Options { /* private fields */ }

Options store for reading configuration values.

Implementations

impl Options

pub fn builder<'a>() -> InitBuilder<'a>

Returns a builder for constructing an Options instance or initializing the global store.

Configure optional parameters with the with_* methods, then finalize with InitBuilder::build for a standalone instance or InitBuilder::init for the global store.

pub fn new() -> Result<Self>

Load options using fallback chain: SENTRY_OPTIONS_DIR env var, then /etc/sentry-options if it exists, otherwise sentry-options/. Expects {dir}/schemas/ and {dir}/values/ subdirectories.

pub fn new_with_propagation_callback( callback: PropagationCallback, ) -> Result<Self>

Like [new], but with a propagation callback that fires (namespace, delay_secs) whenever values are refreshed with a new generated_at timestamp.

pub fn from_directory(base_dir: &Path) -> Result<Self>

Load options from a specific directory (useful for testing). Expects {base_dir}/schemas/ and {base_dir}/values/ subdirectories.

pub fn from_schemas(schemas: &[(&str, &str)]) -> Result<Self>

Load options with schemas provided as in-memory JSON strings. Values are loaded from disk using the standard fallback chain.

pub fn get(&self, namespace: &str, key: &str) -> Result<Value>

Get an option value, returning the schema default if not set.

pub fn get_forced(&self, namespace: &str, key: &str) -> Result<Value>

Like get, but always refreshes. Refresh incurs a cost so this should only be used in testing; use refresh to drive refreshes in production.

pub fn refresh(&self) -> Result<bool>

Refreshes values from disk, ignoring the staleness threshold.

Returns whether a new snapshot was published, i.e. the files changed on disk (by mtime) and reloaded successfully. On error the previous snapshot is retained and served. Callbacks registered with InitBuilder::with_callback fire on the calling thread before this returns.

Any call resets the refresh-on-read timer, so calling this more often than the staleness threshold guarantees reads never refresh inline.

pub fn validate_override( &self, namespace: &str, key: &str, value: &Value, ) -> Result<()>

Validate that a key exists in the schema and the value matches the expected type.

pub fn isset(&self, namespace: &str, key: &str) -> Result<bool>

Check if an option has a value.

Returns true if the option is defined and has a value, will return false if the option is defined and does not have a value.

If the namespace or option are not defined, an Err will be returned.