Enum Format 

pub enum Format {
    Plain,
    Text,
    Json,
    Jsonl,
    Markdown,
}

Output format for rendering structured content.

Determines how Output is rendered to text. Can be customized via Ui::with_format().

Examples

use scriba::Format;

let format = Format::Markdown;
assert_eq!(format.as_str(), "markdown");
assert!(format.is_human());

Variants

Plain

Plain scalar output (string, number, boolean, or null).

Text

Human-readable text with basic formatting.

Json

JSON object representation.

Jsonl

Newline-delimited JSON records.

Markdown

Markdown-formatted output.

Implementations

impl Format

pub fn as_str(self) -> &'static str

Convert format to string representation.

pub fn from_str(s: &str) -> Self

Parse format from string (case-insensitive).

Defaults to Format::Text if unrecognized.

pub fn is_structured(self) -> bool

Check if format is structured (machine-readable JSON-based).

pub fn is_human(self) -> bool

Check if format is human-readable text.

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 Debug for Format

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

Formats the value using the given formatter.

impl PartialEq for Format

fn eq(&self, other: &Format) -> 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 Format

impl Eq for Format

impl StructuralPartialEq for Format