Enum DisplayMode 

pub enum DisplayMode {
    Prod = 0,
    Local = 1,
    Staging = 2,
}

Display mode for error output.

Controls the structure and verbosity of error messages based on the deployment environment. The mode is determined by the MASTERROR_ENV environment variable or auto-detected based on build configuration and runtime environment.

Examples

use masterror::DisplayMode;

let mode = DisplayMode::current();
match mode {
    DisplayMode::Prod => println!("Production mode: JSON output"),
    DisplayMode::Local => println!("Local mode: Human-readable output"),
    DisplayMode::Staging => println!("Staging mode: JSON with context")
}

Variants

Prod = 0

Production mode: lightweight JSON, minimal fields, no sensitive data.

Output includes only: kind, code, message (if not redacted). Metadata is filtered to exclude sensitive fields. Source chain and backtrace are excluded.

Example Output

{"kind":"NotFound","code":"NOT_FOUND","message":"User not found"}

Local = 1

Development mode: human-readable, full context.

Output includes: error details, full source chain, complete metadata, and backtrace (if enabled). Supports colored output when the colored feature is enabled and output is a TTY.

Example Output

Error: NotFound
Code: NOT_FOUND
Message: User not found

  Caused by: database query failed
  Caused by: connection timeout

Context:
  user_id: 12345

Staging = 2

Staging mode: JSON with additional context.

Output includes: kind, code, message, limited source_chain, and filtered metadata. No backtrace.

Example Output

{"kind":"NotFound","code":"NOT_FOUND","message":"User not found","source_chain":["database error"],"metadata":{"user_id":12345}}

Implementations

impl DisplayMode

pub fn current() -> Self

Returns the current display mode based on environment configuration.

The mode is determined by checking (in order):

1. MASTERROR_ENV environment variable (prod, local, or staging)
2. Kubernetes environment detection (KUBERNETES_SERVICE_HOST)
3. Build configuration (cfg!(debug_assertions))

The result is cached for performance.

Examples

use masterror::DisplayMode;

let mode = DisplayMode::current();
assert!(matches!(
    mode,
    DisplayMode::Prod | DisplayMode::Local | DisplayMode::Staging
));

Trait Implementations

impl Clone for DisplayMode

fn clone(&self) -> DisplayMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DisplayMode

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

Formats the value using the given formatter.

impl PartialEq for DisplayMode

fn eq(&self, other: &DisplayMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DisplayMode

impl Eq for DisplayMode

impl StructuralPartialEq for DisplayMode