Core Library0.xAPI Reference

Choose documentation 1

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.

module libtmux-raku latest

LibTmux.Configuration

Source and package
Qualified name
LibTmux::Configuration
Declared in
LibTmux
Package
LibTmux
Source
lib/LibTmux/Configuration.rakumod
Anonymous module

Description#

Configuration and stored commands

Options, Environment, Buffers, Hooks and KeyBindings are value-only facades bound to an endpoint and daemon incarnation. Construction and schema access perform no I/O. Each operation owns and closes its temporary command runtime; it checks daemon identity and applies one timeout and output bound.

Options use source-qualified types and ranges from LibTmux::Catalogue. Flags require Bool, numeric options reject Bool, and array writes require an explicit index. entries preserves inherited provenance; get returns a native scalar or an indexed Map. Unknown native options use the explicitly named raw operations. User options in the typed API use @ followed by letters, digits, underscores or hyphens. Native printed command values are source text, not parsed Invocation values.

Environment reads distinguish an absent entry, an explicit removed marker, and hidden entries. :hidden selects hidden entries only. Environment names use the portable variable alphabet. get requests only that name; list refuses a native entry whose name falls outside the declared alphabet. Values preserve bytes through UTF8-C8; reading the shell-shaped output never executes it. Buffer content is acquired separately as Blob and may contain NUL.

Hooks and key bindings accept LibTmux::Command::Invocation for commands to store. Reads preserve tmux's printed command source without executing or reconstructing it. Legacy key listings mark notes Unloaded; modern projected listings capture them. Key table names use letters, digits, underscores or hyphens so legacy native listings remain unambiguous.

Hook run acknowledges queuing. Paste and other mutations acknowledge tmux commands; they do not prove that a pane application consumed input or that a hook's asynchronous work completed. Timeouts after dispatch cannot roll back server effects. Captured values do not refresh themselves.

Members9#

Collections and queries1#

  • Buffers class Server-scoped paste buffers with binary load and save operations.

Other members8#

  • BufferInfo class Buffer metadata is separate from explicitly acquired binary contents.
  • Environment class Session or global environment, including hidden and removed entries.
  • EnvironmentValue class Environment absence and an explicit removed marker are different states.
  • Hooks class Named hook command arrays. Reading a hook never executes its command source.
  • KeyBinding class Captured binding metadata. Legacy listings leave note-state Unloaded.
  • KeyBindings class Server key tables. Invocation keeps stored command arguments distinct.
  • Options class Typed native options. Reads and writes are explicit daemon operations.
  • OptionValue class One observed option value. The source schema determines its native scalar type.
Esc

Type to search.

Reference previewOpen reference