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.Format

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

Description#

Declared FORMAT projections

A Projection validates ordered catalogue field names, acquisition context, capabilities, and nullable-field dependencies before generating a template. Its schema identifies the field order, codec, and output-repair profile. The separately retained incarnation binds a prepared projection to a daemon; the engine validates that identity before dispatch.

Feed binary output to FrameDecoder and call finish at process completion. An incomplete record, malformed token, exceeded bound, or mismatched schema throws X::LibTmux::Decode and closes the decoder. Row numbers start at one; offsets count bytes from the start of the response. Field conversion errors identify the field's starting offset; token errors locate the offending byte.

DecodedRow.bytes retains exact immutable payload bytes. Its value method performs strict UTF-8 conversion for text only when requested. State reports domain null independently from a present empty string, zero, or false. Rows are constructed through Projection.decode-row and retain the projection's daemon identity as a string; they do not retain an executor or connection. An empty raw q/a token is accepted only when its declared null policy and projected dependencies establish domain null; present empty text remains quoted. No decoding stage evaluates tmux commands, shell syntax, or Raku source.

Members3#

  • DecodedRow class Exact captured field bytes and scalar values. Text conversion is explicit.
  • FrameDecoder class Incremental LF framing over bytes with terminal failure and explicit limits.
  • Projection class Ordered registered fields with an explicit acquisition context and codec.
Esc

Type to search.

Reference previewOpen reference