LibTmux.Id
Distinct session, physical-window and physical-pane IDs.
Source and package
- Qualified name
-
LibTmux. Id - Package
- libtmux-haskell
- Source
- src/LibTmux/Id.hs
- LibTmux.Id
-
Description#
Parsing and rendering are pure. An ID carries no endpoint, server lifetime or liveness evidence. Render an ID for external text; use its numeric accessor when an application needs the mathematical value.
Start with
parseSessionId,parseWindowIdorparsePaneId. Each type's documentation links its parser and renderer. Contextual numeric indices belong toLibTmux.Value.>>> :set -XOverloadedStrings>>> fmap renderWindowId (parseWindowId "@17")Right "@17">>> either (const "rejected") renderPaneId (parsePaneId "@17")"rejected"
Members13#
Common operations1#
- IdError data type Invalid canonical syntax, entity prefix or native unsigned range. Diagnostics retain at most 64 characters of input.
Other members12#
- PaneId data type A physical pane's identifier, written with a
%prefix. Parse withparsePaneId; render withrenderPaneId. - paneIdValue function Read the numeric physical pane ID.
- parsePaneId function Parse a canonical
%numberidentifying a physical pane. - parseSessionId function Parse
$0through$4294967295. No whitespace or leading zeroes. - parseWindowId function Parse a canonical
@numberidentifying a physical window. - renderPaneId function Render the physical pane prefix and decimal ID.
- renderSessionId function Render the session prefix and decimal ID.
- renderWindowId function Render the physical window prefix and decimal ID.
- SessionId data type A session's unsigned 32-bit tmux identifier, written with a
$prefix. Parse withparseSessionId; render withrenderSessionId. - sessionIdValue function Read the numeric session ID without narrowing conversion.
- WindowId data type A physical window's identifier, independent of its session links.
Parse with
parseWindowId; render withrenderWindowId. - windowIdValue function Read the numeric physical window ID.
Guides#
Pages that discuss LibTmux.Id.