Struct Options 

pub struct Options { /* private fields */ }

Options of one report (Rails’ handled:, severity:, context:, source:).

Defaults: handled, Severity::Warning, no context, source application.

Examples

use ocre::errors::{Options, Severity};

let options = Options::new().handled(false).severity(Severity::Error).context("order_id", 42).source("billing");

Implementations

impl Options

pub fn new() -> Self

The defaults: handled, warning, no context, source application.

Examples

let _ = ocre::errors::Options::new();

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

Whether the app recovered from the error (false for errors that failed the request or job).

Examples

let _ = ocre::errors::Options::new().handled(false);

pub fn severity(self, severity: Severity) -> Self

The report’s Severity.

Examples

let _ = ocre::errors::Options::new().severity(ocre::errors::Severity::Info);

pub fn context(self, key: &str, value: impl Serialize) -> Self

Adds a context entry, merged over the request’s Reporter::set_context entries.

A value that does not serialize is null.

Examples

let _ = ocre::errors::Options::new().context("user_id", 7);

pub fn source(self, source: &str) -> Self

Where the error comes from, e.g. billing (Rails’ source:).

Examples

let _ = ocre::errors::Options::new().source("webhooks");

pub fn except(self, subscriber: &'static str) -> Self

Does not send this report to the subscriber named name (Rails’ Rails.error.disable).

For errors a subscriber should not see, such as the failure of its own service. The report is still logged.

Examples

let _ = ocre::errors::Options::new().except("sentry");

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.