Struct Pane

pub struct Pane {
    pub id: PaneId,
    pub index: u16,
    pub is_active: bool,
    pub title: String,
    pub dirpath: PathBuf,
    pub command: String,
}

A Tmux pane.

Fields

id: PaneId

Pane identifier, e.g. %37.

index: u16

Describes the Pane index in the Window

is_active: bool

Describes if the pane is currently active (focused).

title: String

Title of the Pane (usually defaults to the hostname)

dirpath: PathBuf

Current dirpath of the Pane

command: String

Current command executed in the Pane

Implementations

impl Pane

pub async fn capture(&self) -> Result<Vec<u8>>

Return the entire Pane content as a Vec<u8>.

Note

The output contains the escape codes, joined lines with trailing spaces. This output is processed by the function tmux_lib::utils::cleanup_captured_buffer.

Trait Implementations

impl Clone for Pane

fn clone(&self) -> Pane

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pane

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Pane

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for Pane

fn from_str(input: &str) -> Result<Self, Self::Err>

Parse a string containing tmux panes status into a new Pane.

This returns a Result<Pane, Error> as this call can obviously fail if provided an invalid format.

The expected format of the tmux status is

%20:0:false:'rmbp':'nvim':/Users/graelo/code/rust/tmux-backup
%21:1:true:'rmbp':'tmux':/Users/graelo/code/rust/tmux-backup
%27:2:false:'rmbp':'man man':/Users/graelo/code/rust/tmux-backup

This status line is obtained with

tmux list-panes -F "#{pane_id}:#{pane_index}:#{?pane_active,true,false}:'#{pane_title}':'#{pane_current_command}':#{pane_current_path}"

For definitions, look at Pane type and the tmux man page for definitions.

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for Pane

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Pane

impl StructuralPartialEq for Pane