Crate rmux_core 

Pure in-memory RMUX domain model state.

This crate models sessions, windows, panes, layout geometry, and exact target resolution without any OS, network, or process integration.

Re-exports

pub use formats::format_skip_delimiter;

pub use input::colour_join_rgb;

pub use input::Colour;

pub use input::GridAttr;

pub use input::COLOUR_DEFAULT;

pub use input::COLOUR_FLAG_256;

pub use input::COLOUR_FLAG_RGB;

pub use input::COLOUR_NONE;

pub use input::COLOUR_TERMINAL;

pub use style::colour_to_string;

pub use style::parse_colour;

pub use style::style_parse;

pub use style::style_tostring;

pub use style::ColourParseError;

pub use style::Style;

pub use style::StyleAlign;

pub use style::StyleCell;

pub use style::StyleDefaultType;

pub use style::StyleList;

pub use style::StyleParseError;

pub use style::StyleRange;

pub use style::StyleWidth;

Modules

command_inventory

Shared tmux-compatible list-commands inventory and renderer. Shared command inventory and tmux-compatible list-commands rendering.

command_parser

tmux-compatible command tokenization and command-name lookup.

command_queue

tmux-style command queue data model.

events

Bounded event buffers and cursor accounting. Bounded event buffers used by live server subscribers.

formats

tmux-compatible format expansion engine.

identity

Identity vocabulary surface used by rmux-core consumers.

input

tmux-compatible VT parser state machine, CSI/ESC/OSC dispatch, and SGR. tmux-compatible VT parser state machine.

style

tmux-compatible style and colour parsing.

tmux_precedence

tmux-compatible option precedence normalization for command arguments.

Structs

AlertFlags

Runtime alert flag bitset shared by window queue state and winlink-visible state.

BreakPaneOptions

Destination and behavioral flags for breaking a pane into its own window.

BufferStore

Server-wide buffer store.

BufferView

One borrow-only buffer view for list and format rendering.

CommandTargetMetadata

Per-command source and target lookup metadata.

CommandTargetSpec

Per-command source or target lookup metadata from frozen tmux cmd_entry.

EnvironmentStore

In-memory storage for global and session-local environment values.

GridRenderOptions

Rendering flags for tmux-style grid capture.

HookBindingView

A rendered hook binding snapshot.

HookDispatch

The command payload emitted when a hook dispatches.

HookSetOptions

Indexed mutation options for set-hook.

HookStore

In-memory storage for tmux-style hook arrays.

KeyBinding

One bound key in a table.

KeyBindingDisplay

A listed key binding paired with derived display fields.

KeyBindingStore

Global key table store with tmux-style default snapshots.

KeyBindingTable

One key table.

KeyBindingTableRef

A mutable table reference operation result.

KillPaneOutcome

The result of removing one pane from a session window.

OptionMutationOutcome

Outcome for a successful option mutation.

OptionNotification

A server-visible option mutation side effect.

OptionStore

In-memory storage for supported RMUX option values.

Pane

Pure in-memory pane state.

PaneGeometry

A pane rectangle within terminal coordinates.

PaneId

Stable per-server pane identity (%N).

PaneJoinOptions

Behavioral flags for pane joins and moves.

PaneSwapOptions

Behavioral flags for pane swaps.

RecoveryRow

One rendered recovery row: the bytes to replay, the soft-wrap flag, and the columns those bytes paint.

RecoveryRowRenderer

Bounded row renderer used to construct transport-safe recovery frames.

RenameBufferOutcome

Outcome details for a rename operation.

RenderedLineSpan

Columns a rendered grid line paints when it is replayed into a terminal.

Screen

One pane screen, including scrollback, alternate-screen state, cursor position, modes, tab stops, and hyperlink storage.

ScreenCaptureRange

tmux-compatible capture bounds over history plus visible rows.

ScreenCellRef

Borrowed read-only view of one rendered screen cell.

ScreenCellView

Read-only copy of one rendered screen cell for copy-mode consumers.

ScreenLineView

Read-only copy of one absolute screen line for copy-mode consumers.

Session

A single detached RMUX session.

SessionId

Stable per-server session identity ($N).

SessionName

A validated RMUX session name.

SessionPaneTarget

A pane address within a single session.

SessionStore

In-memory storage for all sessions owned by the server.

SetBufferOutcome

The outcome of a set operation on the buffer store.

ShowEnvironmentEntry

Renderable show-environment entry with tmux-compatible flags and tombstones.

TargetFindContext

Current target context used for omitted targets and relative lookup.

TargetFindFlags

Flag bitset matching tmux CMD_FIND_* resolution controls.

TerminalClipboardQuery

A bounded pane-originated OSC 52 clipboard query.

TerminalPaletteIndex

A terminal palette index accepted by OSC 4.

TerminalPassthrough

Opaque terminal command that must be forwarded to a capable outer terminal.

TerminalScreen

Live terminal screen fed by rmux-core’s private parser boundary.

Transcript

Per-pane line transcript bounded by the effective history-limit.

UnresolvedTarget

Raw command target text before tmux-style lookup.

Utf8Config

tmux-compatible runtime width configuration.

Window

A session-owned window whose pane order is independent from pane indices.

WindowId

Stable per-server window identity (@N).

WindowPaneActivity

Exact activity state for one pane and its containing shared window.

Enums

BoxLines

Border drawing variants accepted by tmux *-border-lines options.

HookGlobalRoot

The global root used by a hook inventory query.

HookScopeIdentity

Stable identity used to address a hook scope after target resolution.

KeyBindingSortOrder

Sort orders accepted by list-keys -O.

LifecycleEvent

A typed server lifecycle event that may dispatch a registered hook.

MissingCurrentTargetFallback

Policy for an omitted target when the supplied current target disappeared.

OptionLookupError

Error returned when resolving an option name before validating its value.

ShowOptionsMode

Option rendering mode for show-options.

TargetFindType

The target type requested by a tmux command’s cmd_entry_flag.

TerminalPassthroughKind

Supported terminal passthrough protocol families.

Constants

ENVIRON_HIDDEN

tmux-compatible hidden environment entry flag.

INVALID_SORT_ORDER

tmux-compatible message for invalid -O sort-order arguments.

KEYC_ANY

Any key catch-all.

KEYC_BSPACE

Backspace key.

KEYC_BUILD_MODIFIERS

Build-modifiers flag bit.

KEYC_CTRL

Ctrl modifier bit.

KEYC_CURSOR

Cursor flag bit.

KEYC_DRAGGING

Internal drag-in-progress sentinel key.

KEYC_IMPLIED_META

Implied-meta flag bit.

KEYC_KEYPAD

Keypad flag bit.

KEYC_LITERAL

Literal flag bit.

KEYC_MASK_FLAGS

Flag mask.

KEYC_MASK_KEY

Key payload mask.

KEYC_MASK_MODIFIERS

Modifier mask.

KEYC_MASK_TYPE

Key type mask.

KEYC_META

Meta modifier bit.

KEYC_NONE

No key.

KEYC_SENT

Sent flag bit.

KEYC_SHIFT

Shift modifier bit.

KEYC_UNKNOWN

Unknown key.

KEYC_USER

User key range base.

KEYC_VI

Vi flag bit.

LIST_KEYS_TEMPLATE

Default list-keys template.

WINDOW_ACTIVITY

Window alert queue bit for activity.

WINDOW_ALERTFLAGS

Combined window alert queue bits.

WINDOW_BELL

Window alert queue bit for bells.

WINDOW_SILENCE

Window alert queue bit for silence.

WINLINK_ACTIVITY

Persistent winlink alert bit for activity.

WINLINK_ALERTFLAGS

Combined persistent winlink alert bits.

WINLINK_BELL

Persistent winlink alert bit for bells.

WINLINK_SILENCE

Persistent winlink alert bit for silence.

Functions

alternate_screen_enter_sequence

Returns the preferred alternate-screen enter sequence for term.

alternate_screen_exit_sequence

Returns the preferred alternate-screen exit sequence for term.

command_target_metadata

Returns command target metadata for commands currently routed through the parsed queue.

default_global_scope_for_option_name

Returns the tmux-compatible global option tree for a string option name.

encode_paste_bytes

Encodes bytes for tmux-style safe paste-buffer writes.

fnmatch

Returns whether text matches the tmux-style glob pattern.

hook_explicit_scope_for_target

Normalizes a scope selected explicitly with -w or -p for the hook.

hook_global_root

Returns the global hook root where tmux stores a hook.

hook_natural_scope_for_session_target

Resolves tmux’s natural -t <session> storage scope after the session’s current window and pane have been looked up by the server.

hook_natural_scope_for_target

Resolves the measured natural hook storage scope after target-pane lookup.

key_code_is_mouse_move

Returns whether the key is a mouse-move key.

key_code_lookup_bits

Returns the key bits used for binding lookup.

key_code_to_bytes

Converts a key code into bytes suitable for the legacy direct PTY path.

key_string_lookup_key

Converts a key code into its canonical tmux string.

key_string_lookup_string

Converts a canonical key name into a tmux key code.

option_affects_alerts

Returns whether a known option change may affect alert runtime state.

option_affects_rendering

Returns whether a known option change may affect attached rendering.

option_name_by_name

Resolves a known option by name when the caller only accepts registered options.

parse_binding_command_tokens

Parses a bind-key command payload from raw argv-style tokens.

parse_binding_command_tokens_with_parser

Parses a bind-key payload with the caller’s environment and alias table.

render_dec_modes

Appends the DEC private interactive mode setters implied by mode_bits (and the DECSCUSR cursor_style) to out.

render_dec_modes_for_snapshot

Appends a complete set of tracked terminal-mode transitions for a snapshot.

resolve_option_name

Resolves a known option name using tmux-style aliasing and prefix matching.

resolve_option_name_typed

Resolves an option name and preserves typed lookup failures.

text_width

Returns the tmux-style display width of a string.

truncate_right_to_width

Truncates a string from the left, keeping the rightmost text cells that fit.

truncate_to_width

Truncates a string to the requested display width.

validate_hook_registration

Validates that rmux ships the requested hook and that it may be stored at the requested scope.

validate_hook_scope

Validates that a hook may be stored at the requested scope.

validate_option_mutation

Validates an option mutation against the legacy known-option registry.

validate_option_name_mutation

Validates an option mutation against the open string-keyed registry.

Type Aliases

KeyCode

tmux-style 64-bit key code.