Pane.capture/3
Captures bounded screen bytes through explicit one-shot execution.
Source and package
- Qualified name
-
LibTmux .Pane .capture/3 - Module
- LibTmux
- Declared in
- Pane
- Package
- libtmux
- Source
- lib/libtmux/entities.ex
- capture(connection, ref, options \\ []) @spec capture( Lib
Tmux (), Lib.Action .connection Tmux (), [capture.Ref .t _option ()] ) :: {:ok, LibTmux (binary())} | {:error, Lib.Action .result Tmux ()}.Error .t -
Description#
Returns bytes as
valueafter acknowledged completion and native retirement. Defaults: visible lines 0 through:last, no line joining, 65536 stdout bytes, 65536 stderr bytes and 5000ms.:lastis accepted only forend_line. Negative line numbers include history; tmux clamps the requested range to available lines. Output overflow is an error, never a successful partial screen. This observes rendered screen state, not the program's original output stream.A Control argument returns
unsupported_transport: arbitrary screen bytes are not qualified for shared control framing. No fallback occurs.alias LibTmux.Pane
Pane.capture(server, pane_ref, start_line: -100, max_bytes: 131_072)
- Parameters
-
-
ref(LibTmux ()) #.Ref .t -
options([capture_option ()]) #