API glossary
On this page
Kinds, modifiers and package labels in the Perl 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 Perl API reference.
module#
A loadable Perl source unit, normally a .pm file loaded with use or require.
Namespace names use ::; source paths use directories, such as LibTmux/Selection.pm. One distribution can provide many modules.
References: Perl modules and packages .
class#
A Perl package used as the class of a blessed reference.
LibTmux uses ordinary packages and bless. Selection objects retain native array-reference behavior; their documented methods provide validation and filtering.
References: Perl objects and classes .
method#
A Perl subroutine invoked through a class name or object reference with ->.
The invocant is the first positional argument. Read the signature and method documentation for the remaining arguments, return value and I/O behavior.
References: Perl method invocation .
exception#
A typed Perl value thrown with die and caught by an exception handler.
LibTmux throws blessed error objects with diagnostic fields and readable stringification. Acquisition failures remain errors rather than empty results.
References: Perl exceptions .
Modifiers#
Modifiers add information about calling, implementing, or accessing a declaration. Their precise effect follows the language and the signature.
async#
An operation returning a Future through the optional LibTmux-Async distribution.
Drive completion with the caller-owned IO::Async loop. Cancelling a Future and completing resource cleanup are separate outcomes; successful close completion proves cleanup.
References: Future ; IO::Async::Loop .
inherited#
A method found through Perl package inheritance.
The reference names its declaring package. The inherited method keeps that package’s documented return, ownership and I/O contract.
References: Perl inheritance .
Package context#
Package labels identify where an API is supplied.
package#
The installable Perl distribution supplying this API.
The package badge names a distribution such as LibTmux-Async. A Perl package declaration introduces a namespace; one distribution can contain several namespaces.
References: Preparing Perl distributions .