Enum Format 

#[non_exhaustive]
pub enum Format {
    Auto,
    Compact,
    Pretty,
    Json,
}

Output format for the fmt layer.

Auto is replaced at init time by Format::Pretty when the chosen sink is a TTY and Format::Compact otherwise. Set the KAMU_LOG_FORMAT environment variable (auto, compact, pretty, json) to override without code changes. On wasm32, Auto resolves to Format::Json for Cloudflare Workers Logs-friendly console output, and Format::Pretty falls back to non-ANSI compact output.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Auto

Resolved at init time based on sink + env var.

Compact

Single-line, machine-readable text format.

Pretty

Multi-line, human-readable text format with ANSI colors.

Json

Line-delimited JSON. Required for log aggregators (Vector, Promtail, Datadog Agent, Fluent Bit).

Implementations

impl Format

pub fn from_env_value(value: &str) -> Result<Self, ParseFormatError>

Parse an env-var value.

Errors

Returns ParseFormatError instead of silently selecting Self::Auto when the value is unknown.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Format

impl Debug for Format

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

Formats the value using the given formatter.

impl Default for Format

fn default() -> Format

Returns the “default value” for a type.

impl Eq for Format

impl FromStr for Format

type Err = ParseFormatError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Format

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Format