Schema
Defines observed fields, wire names and graph relations.
Source and package
- Qualified name
-
LibTmux .Schema - Module
- LibTmux
- Package
- libtmux
- Source
- lib/libtmux/schema.ex
-
Description#
The table is a semantic overlay on tmux 3.3 format variables. It drives observation validation, portable filtering and reference generation. Empty text remains text; only explicitly nullable fields admit
nil.Discussed in Observation and filter schema
Members17#
Common operations1#
- fields/1 function Returns the whitelisted field metadata for an entity.
Other members16#
- entities/0 function Returns supported entity names in a stable order.
- entity_module/0: entity
_module () :: LibTmux | Lib.Session Tmux | Lib.Window Tmux | Lib.Window Link Tmux | Lib.Pane Tmux typealias The observation struct modules accepted alongside canonical entity names..Client - entity_selector/0: entity
_selector () :: entity() | entity_module () typealias A canonical entity atom or its corresponding observation module. - entity/0: entity() :: :session | :window | :window_link | :pane | :client typealias An entity's canonical local name. Physical windows and membership links are distinct.
- entity/1 function Resolves an entity atom or its observation module.
- field/0: field() :: %{
name: atom(),
wire: String
.t (), format: String.t () | nil, type: value_type (), since: String.t (), nullable: boolean() } typealias Field metadata shared by validation and documentation; nil format identifies a derived field. - field/2 function Returns field metadata, or nil for a field outside the schema.
- module/1 function Returns the ordinary observation struct module for an entity.
- observation/0: observation() ::
Lib
Tmux () | Lib.Session .t Tmux () | Lib.Window .t Tmux () | Lib.Window Link .t Tmux () | Lib.Pane .t Tmux () typealias One physical or contextual observation from a captured graph..Client .t - observed/1: observed(value) :: value | :unloaded | :unavailable typealias A known value, unloaded coverage, or an unavailable capability; nil belongs to the value type.
- operator/0: operator() :: :equals | :not | :in | :not_in | :lt | :lte | :gt | :gte | :contains | :starts_with | :ends_with typealias A scalar filter operator; each field category permits only its applicable subset.
- operators/1 function Returns the portable operators allowed by a scalar field's value category.
- relation_wire/1 function Returns a relation's explicit stable wire name.
- relation/0: relation() :: {:one | :many, entity()} typealias The cardinality and target entity of one indexed graph relation.
- relations/1 function Returns each relation's cardinality and target entity.
- value_type/0: value
_type () :: :string | :integer | :nullable_integer | :boolean | {:id, entity()} typealias A field's validation category; integer fields use the schema's nonnegative 32-bit range.