API glossary
On this page
Kinds, modifiers and package labels in the Erlang API reference. Select an annotation or full API badge to open its definition here.
The signature and entry documentation describe the API’s behavior, including its calling conventions, storage and runtime checks.
Symbol kinds#
Kinds identify declarations in the Erlang API reference.
module#
An Erlang module grouping function, type and record declarations under an atom name.
Exports identify which functions, types and native records callers can use. Maps, lists and records are values passed explicitly to module functions.
References: Erlang modules .
struct#
An exported Erlang native record with a fixed set of named fields, owned by its defining module.
Session, window, window-link and pane rows use native records. Import an exported definition with -import_record(tmux_model, [pane]). Native records remain experimental in OTP 29.1.2; their internals are not a wire format.
References: Erlang native records .
function#
An Erlang function identified by its module, name and arity, the number of arguments.
Functions sharing a name with different arities are distinct. Multiple clauses belong to one function; patterns and guards select the clause to execute.
References: Erlang functions .
typealias#
An Erlang type declaration written with -type, -opaque or -nominal, identified by module, name and arity.
The shared typealias badge includes nominal IDs: Dialyzer distinguishes their declared names even when each is represented by a binary. Typespecs support analysis and documentation; runtime input validation remains necessary.
References: Erlang user-defined types .
Modifiers#
Modifiers add information about calling, implementing, or accessing a declaration. Their precise effect follows the language and the signature.
opaque#
An Erlang type declared with -opaque, whose representation callers must not depend on.
Selections and queries are opaque values. Use tmux_select:to_list/1 to obtain rows for lists functions, and tmux_query:fetch/1 to execute a query. Ordinary selection reads and query construction perform no tmux I/O.
References: Erlang opaque types .
abstract#
An Erlang behaviour callback declared with -callback, whose implementation belongs to a callback module.
The declaration describes the callback contract; it does not provide a function body to call on the behaviour module.
References: Erlang behaviour callbacks .
Package context#
Package labels identify where an API is supplied.
package#
The OTP application supplying these Erlang modules, described by an application resource file.
The core application is libtmux_erlang. Its application name and the names of its modules serve different roles; use the documented source dependency to install it.
References: OTP applications .