Struct FormatContext 

pub struct FormatContext { /* private fields */ }

Format values populated from session, window, pane, and server-side context.

Implementations

impl FormatContext

pub fn new() -> Self

Creates an empty format context.

pub fn from_session(session: &Session) -> Self

Creates a format context populated from a session.

pub fn with_session(self, session: &Session) -> Self

Populates session-level variables from a session.

pub const fn with_session_attached(self, attached_count: usize) -> Self

Populates the externally tracked attached-client count.

pub fn with_window( self, window_index: u32, window: &Window, active: bool, last: bool, ) -> Self

Populates window-level variables from a window and its session-local state.

pub fn with_pane(self, pane: &Pane, active: bool) -> Self

Populates pane-level variables from a pane and its window-local state.

pub fn with_window_pane(self, window: &Window, pane: &Pane) -> Self

Populates pane-level variables, deriving active state from the owning window.

pub fn with_named_value( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Populates an arbitrary named format variable.

Trait Implementations

impl Clone for FormatContext

fn clone(&self) -> FormatContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormatContext

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

Formats the value using the given formatter.

impl Default for FormatContext

fn default() -> FormatContext

Returns the “default value” for a type.

impl FormatVariables for FormatContext

fn format_value(&self, variable: FormatVariable) -> Option<String>

Resolves a supported format variable to its rendered value.

fn format_value_by_name(&self, name: &str) -> Option<String>

Resolves an arbitrary string-keyed variable name.

fn format_name_exists(&self, _scope: Option<char>, _name: &str) -> Option<bool>

Checks whether a window or session name exists for the N: modifier.

fn format_loop( &self, _scope: char, _body: &str, _count_only: bool, ) -> Option<String>

Expands runtime loop modifiers such as S, W, and P.

impl PartialEq for FormatContext

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

impl StructuralPartialEq for FormatContext