{"schema":1,"title":"API glossary","description":"Kinds, modifiers and package labels in the Perl API reference.","url":"https://libtmux.org/en/perl/latest/reference/glossary/","groups":[{"id":"symbol-kinds","title":"Symbol kinds","description":"Kinds identify declarations in the Perl API reference.","terms":[{"id":"module","definition":"A loadable Perl source unit, normally a .pm file loaded with use or require.","detail":"Namespace names use ::; source paths use directories, such as LibTmux/Selection.pm. One distribution can provide many modules.","references":[{"title":"Perl modules and packages","url":"https://perldoc.perl.org/5.44.0/perlmod"}],"url":"https://libtmux.org/en/perl/latest/reference/glossary/#module"},{"id":"class","definition":"A Perl package used as the class of a blessed reference.","detail":"LibTmux uses ordinary packages and bless. Selection objects retain native array-reference behavior; their documented methods provide validation and filtering.","references":[{"title":"Perl objects and classes","url":"https://perldoc.perl.org/5.44.0/perlobj"}],"url":"https://libtmux.org/en/perl/latest/reference/glossary/#class"},{"id":"method","definition":"A Perl subroutine invoked through a class name or object reference with ->.","detail":"The invocant is the first positional argument. Read the signature and method documentation for the remaining arguments, return value and I/O behavior.","references":[{"title":"Perl method invocation","url":"https://perldoc.perl.org/5.44.0/perlobj#Method-Invocation"}],"url":"https://libtmux.org/en/perl/latest/reference/glossary/#method"},{"id":"exception","definition":"A typed Perl value thrown with die and caught by an exception handler.","detail":"LibTmux throws blessed error objects with diagnostic fields and readable stringification. Acquisition failures remain errors rather than empty results.","references":[{"title":"Perl exceptions","url":"https://perldoc.perl.org/5.44.0/functions/die"}],"url":"https://libtmux.org/en/perl/latest/reference/glossary/#exception"}]},{"id":"modifiers","title":"Modifiers","description":"Modifiers add information about calling, implementing, or accessing a declaration. Their precise effect follows the language and the signature.","terms":[{"id":"async","definition":"An operation returning a Future through the optional LibTmux-Async distribution.","detail":"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":[{"title":"Future","url":"https://metacpan.org/pod/Future"},{"title":"IO::Async::Loop","url":"https://metacpan.org/pod/IO::Async::Loop"}],"url":"https://libtmux.org/en/perl/latest/reference/glossary/#async"},{"id":"inherited","definition":"A method found through Perl package inheritance.","detail":"The reference names its declaring package. The inherited method keeps that package’s documented return, ownership and I/O contract.","references":[{"title":"Perl inheritance","url":"https://perldoc.perl.org/5.44.0/perlobj#Inheritance"}],"url":"https://libtmux.org/en/perl/latest/reference/glossary/#inherited"}]},{"id":"package-context","title":"Package context","description":"Package labels identify where an API is supplied.","terms":[{"id":"package","definition":"The installable Perl distribution supplying this API.","detail":"The package badge names a distribution such as LibTmux-Async. A Perl package declaration introduces a namespace; one distribution can contain several namespaces.","references":[{"title":"Preparing Perl distributions","url":"https://perldoc.perl.org/5.44.0/perlnewmod"}],"url":"https://libtmux.org/en/perl/latest/reference/glossary/#package"}]}]}