PaneOutput
What one pane writes, as it writes it.
Source and package
- Qualified name
-
libtmux::control:: Pane Output - Module
- control
- Package
- libtmux
- Source
- crates/libtmux/src/control.rs
-
Description#
Built by
crate::Pane::stream_output(). This is aStreamof the bytes that pane produced, in order. Its infallible items combine normal termination, connection failure, and the watched pane being killed intoNone, once whatever was already buffered has drained. CallSelf::shutdown()to observe a connection error, or useControlEventsto receive errors during iteration; a killed pane is not an error either way, since ending is the correct answer once nothing more will arrive.tmux is told to send this connection nothing but the watched pane. A neighbouring pane running
yesotherwise moves tens of megabytes a second through it, and the watched pane's output queues behind that.Each of these owns a control-mode connection, so a caller watching many panes at once is better served by
ControlEventsand one connection, narrowed withControlSender::watch_only().
Members5#
Common operations1#
- snapshot method Capture the pane's visible screen at an ordered point in this stream.
Other members4#
- next_chunk method Return the next chunk this pane wrote, or
Noneonce it stops. - pane method Return the pane being watched.
- sender method Return the connection this stream reads, to mute or resume panes on it.
- shutdown method End the connection and report how it went.