Struct TabInfo 

pub struct TabInfo {

    pub position: usize,
    pub name: String,
    pub active: bool,
    pub panes_to_hide: usize,
    pub is_fullscreen_active: bool,
    pub is_sync_panes_active: bool,
    pub are_floating_panes_visible: bool,
    pub other_focused_clients: Vec<ClientId>,
    pub active_swap_layout_name: Option<String>,
    pub is_swap_layout_dirty: bool,
    pub viewport_rows: usize,
    pub viewport_columns: usize,
    pub display_area_rows: usize,
    pub display_area_columns: usize,
    pub selectable_tiled_panes_count: usize,
    pub selectable_floating_panes_count: usize,
    pub tab_id: usize,
    pub has_bell_notification: bool,
    pub is_flashing_bell: bool,
}

Contains all the information for a currently opened tab.

Fields

position: usize

The Tab’s 0 indexed position

name: String

The name of the tab as it appears in the UI (if there’s enough room for it)

active: bool

Whether this tab is focused

panes_to_hide: usize

The number of suppressed panes this tab has

is_fullscreen_active: bool

Whether there’s one pane taking up the whole display area on this tab

is_sync_panes_active: bool

Whether input sent to this tab will be synced to all panes in it

are_floating_panes_visible: bool

other_focused_clients: Vec<ClientId>

active_swap_layout_name: Option<String>

is_swap_layout_dirty: bool

Whether the user manually changed the layout, moving out of the swap layout scheme

viewport_rows: usize

Row count in the viewport (including all non-ui panes, eg. will excluse the status bar)

viewport_columns: usize

Column count in the viewport (including all non-ui panes, eg. will excluse the status bar)

display_area_rows: usize

Row count in the display area (including all panes, will typically be larger than the viewport)

display_area_columns: usize

Column count in the display area (including all panes, will typically be larger than the viewport)

selectable_tiled_panes_count: usize

The number of selectable (eg. not the UI bars) tiled panes currently in this tab

selectable_floating_panes_count: usize

The number of selectable (eg. not the UI bars) floating panes currently in this tab

tab_id: usize

The stable identifier for this tab

has_bell_notification: bool

Whether this tab has an active (persistent) bell notification

is_flashing_bell: bool

Whether this tab is currently flashing its bell (transient 400ms state)

Implementations

impl TabInfo

pub fn decode_from_kdl(kdl_document: &KdlDocument) -> Result<Self, String>

pub fn encode_to_kdl(&self) -> KdlDocument

Trait Implementations

impl Clone for TabInfo

fn clone(&self) -> TabInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TabInfo

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

Formats the value using the given formatter.

impl Default for TabInfo

fn default() -> TabInfo

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TabInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for TabInfo

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 TabInfo

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<TabInfo> for TabInfo

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(protobuf_tab_info: ProtobufTabInfo) -> Result<Self, &'static str>

Performs the conversion.

impl TryFrom<TabInfo> for ProtobufTabInfo

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(tab_info: TabInfo) -> Result<Self, &'static str>

Performs the conversion.

impl Eq for TabInfo

impl StructuralPartialEq for TabInfo