Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

struct libtmux-rs latest

ControlSender

Sends commands down a control-mode connection.

Source and package
Qualified name
libtmux::control::ControlSender
Module
control
Package
libtmux
Source
crates/libtmux/src/control.rs
struct control.ControlSender

Description#

Cheap to clone, and every method that sends takes &self, so several tasks can issue commands while another watches events.

Members10#

Common operations4#

  • reply_timeout method Set how long a command waits for its result block.
  • send method Send one command and wait for its result block.
  • watch_only method Receive output from these panes and no others.
  • subscribe method Ask tmux to report a format whenever it changes.

Other members6#

  • is_closed method Report whether the connection has closed.
  • mute_pane method Stop tmux sending this connection what a pane writes.
  • pause_after method Have tmux pause a pane rather than let this connection fall behind.
  • resume_pane method Resume a pane tmux paused because this connection fell behind, or one Self::mute_pane() muted.
  • unmute_pane method Resume sending what a pane writes, after Self::mute_pane().
  • unsubscribe method Stop reporting a format this connection subscribed to.
Esc

Type to search.

Reference previewOpen reference