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.

method libtmux-rs latest

ControlSender.unmute_pane

Resume sending what a pane writes, after Self::mute_pane().

Source and package
Qualified name
libtmux::control::ControlSender::unmute_pane
Module
control
Declared in
ControlSender
Package
libtmux
Source
crates/libtmux/src/control.rs
pub async fn unmute_pane(&self, pane: &PaneId) -> Result< (), Error >

Description#

Below crate::since::CONTROL_PANE_OFF, Self::mute_pane() paused the pane rather than taking it out of the stream, and this continues it: tmux resumes from the pane's current output rather than replaying what was skipped, so the caller sees a gap, not a backlog.

At or above that release, Self::mute_pane() took the pane out of the stream instead, which also stopped tmux reading its pty; this turns that back on, and everything written while muted arrives at once, as a backlog rather than a gap.

This sends both tmux commands in one dispatch rather than choosing between them, so it is exactly Self::resume_pane() -- either name undoes Self::mute_pane() correctly regardless of which mechanism the running tmux used.

Errors

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

Parameters

tmux command#

The tmux commands behind unmute_pane.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference