Struct RenderContext 

pub struct RenderContext<'a> {
    pub output_mode: OutputMode,
    pub terminal_width: Option<usize>,
    pub theme: &'a Theme,
    pub data: &'a Value,
    pub extras: HashMap<String, String>,
}

Information available at render time for dynamic context providers.

This struct is passed to ContextProvider::provide to allow context objects to be configured based on runtime conditions.

Fields

• output_mode: The current output mode (Term, Text, Json, etc.)
• terminal_width: Terminal width in columns, if known
• theme: The theme being used for rendering
• data: The handler’s output data as a JSON value
• extras: Additional string key-value pairs for extension

Example

use standout::context::RenderContext;
use standout::{OutputMode, Theme};

let ctx = RenderContext {
    output_mode: OutputMode::Term,
    terminal_width: Some(120),
    theme: &Theme::new(),
    data: &serde_json::json!({"count": 42}),
    extras: std::collections::HashMap::new(),
};

// Use context to configure a formatter
let width = ctx.terminal_width.unwrap_or(80);

Fields

output_mode: OutputMode

The output mode for rendering (Term, Text, Json, etc.)

terminal_width: Option<usize>

Terminal width in columns, if available.

This is None when:

• Output is not to a terminal (piped, redirected)
• Terminal width cannot be determined
• Running in a non-TTY environment

theme: &'a Theme

The theme being used for rendering.

data: &'a Value

The handler’s output data, serialized as JSON.

This allows context providers to inspect the data being rendered and adjust their behavior accordingly.

extras: HashMap<String, String>

Additional string key-value pairs for extension.

This allows passing arbitrary metadata to context providers without modifying the struct definition.

Implementations

impl<'a> RenderContext<'a>

pub fn new( output_mode: OutputMode, terminal_width: Option<usize>, theme: &'a Theme, data: &'a Value, ) -> Self

Creates a new render context with the given parameters.

pub fn with_extra( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Adds an extra key-value pair to the context.

pub fn get_extra(&self, key: &str) -> Option<&str>

Gets an extra value by key.

Trait Implementations

impl<'a> Clone for RenderContext<'a>

fn clone(&self) -> RenderContext<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RenderContext<'a>

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

Formats the value using the given formatter.