Enum FormatVariable 

pub enum FormatVariable {
    SessionName,
    SessionWindows,
    SessionAttached,
    SessionWidth,
    SessionHeight,
    WindowIndex,
    WindowId,
    WindowName,
    WindowRawFlags,
    WindowPanes,
    WindowWidth,
    WindowHeight,
    WindowLayout,
    WindowActive,
    WindowLastFlag,
    PaneIndex,
    PaneId,
    PaneActive,
    PaneWidth,
    PaneHeight,
}

A supported format variable name.

Variants

SessionName

The session name.

SessionWindows

The number of windows in the session.

SessionAttached

The number of clients attached to the session.

SessionWidth

The session width in columns.

SessionHeight

The session height in rows.

WindowIndex

The window index within the session.

WindowId

The stable window identifier, rendered with an @ prefix.

WindowName

The window name, or an empty string when unnamed.

WindowRawFlags

The derived active or last-window marker.

WindowPanes

The number of panes in the window.

WindowWidth

The window width in columns.

WindowHeight

The window height in rows.

WindowLayout

The window layout name.

WindowActive

Whether the window is active, rendered as 1 or 0.

WindowLastFlag

Whether the window is the last window, rendered as 1 or 0.

PaneIndex

The pane index within the window.

PaneId

The stable pane identifier, rendered with a % prefix.

PaneActive

Whether the pane is active, rendered as 1 or 0.

PaneWidth

The pane width in columns.

PaneHeight

The pane height in rows.

Implementations

impl FormatVariable

pub fn from_name(name: &str) -> Option<Self>

Parses a supported format variable name.

pub const fn name(self) -> &'static str

Returns the canonical supported variable name.

Trait Implementations

impl Clone for FormatVariable

fn clone(&self) -> FormatVariable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormatVariable

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

Formats the value using the given formatter.

impl Hash for FormatVariable

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FormatVariable

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

impl Eq for FormatVariable

impl StructuralPartialEq for FormatVariable