{"schema":1,"title":"API glossary","description":"Kinds, modifiers and package labels in the Raku API reference.","url":"https://libtmux.org/en/raku/latest/reference/glossary/","groups":[{"id":"symbol-kinds","title":"Symbol kinds","description":"Kinds identify declarations in the Raku API reference.","terms":[{"id":"module","definition":"A Raku compilation unit that declares packages and exports declarations with is export.","detail":"The module badge names a namespace. LibTmux re-exports the public declarations of its modules, so use LibTmux gives programs the common names. A distribution and a module are different identities.","references":[{"title":"Raku modules","url":"https://docs.raku.org/language/modules"}],"url":"https://libtmux.org/en/raku/latest/reference/glossary/#module"},{"id":"class","definition":"A Raku class: a package that creates objects with its own attributes and methods.","detail":"A captured model class reads local state. A reference class such as PaneRef names a tmux object and sends commands on request.","references":[{"title":"Raku type system","url":"https://docs.raku.org/language/typesystem"}],"url":"https://libtmux.org/en/raku/latest/reference/glossary/#class"},{"id":"enum","definition":"A Raku enumeration: a set of named constants of one type.","detail":"Members compare by identity and keep their declared order.","references":[{"title":"Raku type system","url":"https://docs.raku.org/language/typesystem"}],"url":"https://libtmux.org/en/raku/latest/reference/glossary/#enum"},{"id":"trait","definition":"A Raku trait modifies a declaration with is, does or of.","detail":"A trait changes how the declaration behaves; it is not a Rust or Java trait.","references":[{"title":"Raku traits","url":"https://docs.raku.org/language/traits"}],"url":"https://libtmux.org/en/raku/latest/reference/glossary/#trait"},{"id":"function","definition":"A Raku sub: a routine called by name with no invocant.","detail":"A function with a hyphenated name is called as written, such as decode-layout.","references":[{"title":"Raku functions","url":"https://docs.raku.org/language/functions"}],"url":"https://libtmux.org/en/raku/latest/reference/glossary/#function"},{"id":"method","definition":"A Raku method invoked on an object or a type object with a dot.","detail":"The invocant is implicit. A method that talks to tmux says so in its summary; one that reads a captured snapshot does not. A name ending in -async returns a Promise.","references":[{"title":"Raku objects","url":"https://docs.raku.org/language/objects"}],"url":"https://libtmux.org/en/raku/latest/reference/glossary/#method"},{"id":"property","definition":"A public attribute accessor or a method declared as a field of a captured record.","detail":"Reading it returns the value the snapshot captured and performs no I/O.","references":[{"title":"Raku objects","url":"https://docs.raku.org/language/objects"}],"url":"https://libtmux.org/en/raku/latest/reference/glossary/#property"},{"id":"constant","definition":"A named Raku value or enumeration member that cannot be reassigned.","detail":"An enumeration member is also listed under its enum.","references":[{"title":"Raku variables","url":"https://docs.raku.org/language/variables"}],"url":"https://libtmux.org/en/raku/latest/reference/glossary/#constant"},{"id":"typealias","definition":"A Raku subset or type constraint that gives a checked name to a narrower type.","detail":"The constraint runs when a value is bound. It does not create a new class.","references":[{"title":"Raku type system","url":"https://docs.raku.org/language/typesystem"}],"url":"https://libtmux.org/en/raku/latest/reference/glossary/#typealias"},{"id":"exception","definition":"A Raku exception class that callers throw, catch with CATCH or try, and inspect by type.","detail":"LibTmux exceptions live under X::LibTmux and carry the fields the failure produced.","references":[{"title":"Raku exceptions","url":"https://docs.raku.org/language/exceptions"}],"url":"https://libtmux.org/en/raku/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 that returns a Promise and completes on the Raku scheduler.","detail":"Await the Promise or consume it with react and whenever. Completion of the Promise and release of its resources are separate; close what the operation owns.","references":[{"title":"Raku concurrency","url":"https://docs.raku.org/language/concurrency"}],"url":"https://libtmux.org/en/raku/latest/reference/glossary/#async"},{"id":"overload","definition":"One of several multi declarations that share a name and differ in their signatures.","detail":"Raku selects the candidate from the argument types at the call. Read each signature for the types it accepts.","references":[{"title":"Raku functions","url":"https://docs.raku.org/language/functions"}],"url":"https://libtmux.org/en/raku/latest/reference/glossary/#overload"},{"id":"inherited","definition":"A method found through Raku class inheritance.","detail":"The page names the declaring class. A subclass reuses the method and its documented behavior unchanged.","references":[{"title":"Raku type system","url":"https://docs.raku.org/language/typesystem"}],"url":"https://libtmux.org/en/raku/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 Raku distribution supplying this API, identified by name and authority.","detail":"The distribution LibTmux:auth<zef:libtmux> provides these modules.","references":[{"title":"Raku modules","url":"https://docs.raku.org/language/modules"}],"url":"https://libtmux.org/en/raku/latest/reference/glossary/#package"}]}]}