Core LibraryalphaAPI Reference

Choose documentation 1

latest

Current version

latest
English

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

typealias libtmux-elixir latest

Capture.option/0

Capture-wide budgets shared by all attempts and reads.

Source and package
Qualified name
LibTmux.Capture.option/0
Module
LibTmux
Declared in
Capture
Package
libtmux
Source
lib/libtmux/capture.ex
@type option() :: {:timeout, pos_integer()} | {:deadline, LibTmux.Deadline.t()} | {:attempts, 1..3} | {:max_entities | :max_commands | :max_bytes | :max_response_bytes, pos_integer()}

Description#

Each read uses the smaller of remaining max_bytes and max_response_bytes. That effective ceiling must fit OneShot's 16 MiB stdout limit. The shared deadline must have at most 600,000 ms remaining when OneShot validates a read. Invalid combinations raise ArgumentError before that command executes.

Esc

Type to search.

Reference preview Open reference