Struct ControlClient 

pub struct ControlClient { /* private fields */ }

Implementations

impl ControlClient

pub fn attach(tmux: &Tmux, session: &str, size: (u16, u16)) -> Result<Self>

Attach to session in control mode.

pub fn send_command(&mut self, command: &str) -> Result<()>

Send a tmux command. Its reply arrives as an Event::CommandReply.

pub fn try_event(&self) -> Result<Event, TryRecvError>

pub fn next_event(&self, timeout: Duration) -> Result<Event>

Block for the next event, up to timeout.

pub fn wait_for( &self, timeout: Duration, predicate: impl FnMut(&Event) -> bool, ) -> Result<Vec<Event>>

Collect events until predicate matches, or timeout elapses.

Returns everything seen, matching event last. Useful because tmux interleaves pane output with command replies.

pub fn resize(&mut self, cols: u16, rows: u16) -> Result<()>

Tell tmux the client’s terminal changed size.

tmux ignores the pty winsize of a control-mode client entirely — the only thing that moves a pane is refresh-client -C. Resizing the pty alone leaves the pane at its creation size while the emulator believes otherwise, and every absolute cursor address then lands on the wrong row. The pty is resized too so the two agree, but the command is what counts.

pub fn shutdown(&mut self) -> Result<()>

Detach and reap. Idempotent.

Trait Implementations

impl Drop for ControlClient

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.