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

OneShot.option/0

Per-call input and capture limits; bytes and chunks are bounded independently.

Source and package
Qualified name
LibTmux.Transport.OneShot.option/0
Module
LibTmux.Transport
Declared in
OneShot
Package
libtmux
Source
lib/libtmux/transport/oneshot.ex
@type option() :: {:timeout, 1..600_000} | {:deadline, LibTmux.Deadline.t()} | {:cwd, String.t()} | {:env, %{optional(binary()) => binary()}} | {:max_stdout_bytes | :max_stderr_bytes, 0..16_777_216} | {:max_total_bytes, nil | 0..33_554_432} | {:max_chunks, 1..65536}

Description#

Timeout and deadline are exclusive. A supplied deadline must have at most 600,000 ms remaining at validation; it preserves its original cutoff.

Esc

Type to search.

Reference preview Open reference