Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

control.ControlSender.unmute_pane

Rust
  • Python Unavailable
  • TypeScript Unavailable
  • Rust
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift Unavailable

View as Markdown

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

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

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.

0 declared, 0 inherited

Esc

Type to search.