libtmux Reference MCP Search
On this page

control.ControlSender.mute_pane

View as Markdown

Module
control
Declared in
ControlSender
Package
libtmux
Source
crates/libtmux/src/control.rs
mute_pane ( self , pane : &PaneId ) Result<(), Error>
method [source]
method [source]
mute_pane

Stop tmux sending this connection what a pane writes.

A control client is sent the output of every pane in the session it attached to, which is one window's worth or a hundred. One pane running yes moves more than 20 MB in two seconds, and a client tmux judges five minutes behind is disconnected with too far behind, so discarding the unwanted panes on arrival is not enough.

Muting a pane that does not exist is not an error; tmux ignores an unresolvable id here.

Below crate::since::CONTROL_PANE_OFF this pauses the pane rather than taking it out of the stream, because taking it out crashes the server. tmux reports a paused pane, so a caller reading [ ControlEvents ] sees Event::Paused for it there and not on a newer tmux. The pane stops arriving either way; what a paused pane costs is the back-pressure, since tmux keeps draining its terminal.

Errors

Returns an error when the connection has closed or tmux refuses the stream change.

0 declared, 0 inherited

Esc

Type to search.