LibTmux.Value
Positive dimensions and nonnegative contextual indices.
Source and package
- Qualified name
-
LibTmux. Value - Package
- libtmux-haskell
- Source
- src/LibTmux/Value.hs
- LibTmux.Value
-
Description#
Construction and access are pure. Window-link indices and pane indices have distinct types; neither substitutes for an entity ID. A constructor checks the mathematical domain, while command-specific limits belong at the operation boundary. Use
mkDimension,mkWindowIndexandmkPaneIndexto validate input; their accessors return mathematical integers. Entity identifiers belong toLibTmux.Id.>>> fmap dimensionValue (mkDimension 120)Right 120>>> mkDimension 0Left (NonPositiveDimension 0)
Members10#
Common operations1#
- ValueError data type A scalar outside its mathematical domain.
Other members9#
- Dimension data type Positive cells, constructed with
mkDimension. Command and field limits are checked separately. Compare dimensions directly or usedimensionValuewith an integer literal. - dimensionValue function Read a dimension as a mathematical integer, without narrowing conversion.
- mkDimension function Construct a positive dimension without applying a command-specific maximum.
- mkPaneIndex function Construct a nonnegative pane index.
- mkWindowIndex function Construct a nonnegative window-link index.
- PaneIndex data type Nonnegative pane index within a window, not a pane ID.
Construct with
mkPaneIndex; read withpaneIndexValue. - paneIndexValue function Read a pane index as a mathematical integer.
- WindowIndex data type Nonnegative index of a window link within a session, not a physical window ID.
Construct with
mkWindowIndex; read withwindowIndexValue. - windowIndexValue function Read a window-link index as a mathematical integer.
Guides#
Pages that discuss LibTmux.Value.