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

Pane.stream_output_with_limits

Like Self::stream_output(), with explicit frame budgets.

Source and package
Qualified name
libtmux::pane::Pane::stream_output_with_limits
Module
pane
Declared in
Pane
Package
libtmux
Source
crates/libtmux/src/pane/observe.rs
#[cfg(feature = "control-mode")] pub async fn stream_output_with_limits( &self, limits: crate::ControlLimits, ) -> Result<crate::control::PaneOutput, Error>

Description#

The connection this opens is a whole %begin/%end-framed control-mode session, not only this one pane's bytes, so a budget set here bounds every frame that connection reads -- the same tradeoff crate::control::ControlMode::attach_with_limits() documents.

Errors

Returns the same errors as Self::stream_output().

Cancel safety

Nothing is left held, as for Self::stream_output().

Esc

Type to search.

Reference previewOpen reference