Skip to main content

Crate alma

Crate alma 

Source
Expand description

Core library for the Alma Bevy application.

Re-exports§

pub use text_stream::TextByteStream;
pub use text_stream::TextStreamError;

Modules§

text_stream
UTF-8 byte-stream storage and editing. Validated UTF-8 byte stream storage and CRUD operations.

Structs§

ActionContext
State borrowed by one action dispatch.
ActionDispatcher
Action dispatcher.
BufferEditReport
Revision metadata returned after a successful buffer edit.
BufferFile
Buffer metadata for an optional file on disk.
CharSearch
A Vim f/F/t/T character-search motion.
Count
Non-zero Vim count.
Counted
A parsed item with Vim’s generic count prefix.
EditorBackendAdapter
Adapter contract for editor rendering/editing backends.
EditorBackendSnapshot
Snapshot of the editor state last pushed into the visual backend.
FilesystemConfig
Filesystem policy used by editor file I/O.
KeySequence
A normalized key sequence.
Keymap
One typed key mapping.
KeymapSet
A collection of keymaps.
LeaderBinding
A typed leader key binding.
LeaderConfig
Configurable leader behavior.
LeaderState
Normal-mode leader key state.
ModeSet
Modes where a keymap applies.
NormalCommandContext
Normal-command context.
NormalGrammar
Stateful normal-mode grammar parser.
NormalState
Normal-mode controller.
SearchQuery
User-provided literal search query.
SearchState
Current search command state.
VimCommandState
Command-line state for Vim : commands.
VimCommandText
User-provided text following a Vim : prompt.
VimConfig
Vim configuration resource.
VimCursor
Cursor state for navigating the managed text stream.
VimSelection
Character-wise visual selection anchored at a byte index.
VimSelectionState
Current visual selection anchor, if visual mode is active.
VimStatusLine
Bottom status line state shared by Vim command handlers and the renderer.
VisualCommandContext
Visual-command context.
VisualState
Visual-mode controller.

Enums§

BufferEdit
A synchronous mutation against the authoritative text buffer.
BufferOpenError
Errors that can occur while opening the initial buffer.
BufferWriteError
Errors that can occur while writing the current buffer.
BuiltinAction
Builtin actions that require application state beyond pure command execution.
CharSearchDirection
Character-search motion direction.
CharSearchPlacement
Character-search landing behavior.
EditorSyncReport
Result of one editor/backend synchronization step.
KeyAction
A typed key action.
KeyToken
A normalized key token consumed by Vim grammar and keymaps.
LineAddress
Line-address motion targets.
ModeSwitch
Supported mode switches from normal mode.
Motion
Supported Vim motions.
NormalCommand
A typed normal-mode command emitted by the grammar.
NormalGrammarOutput
Output from feeding one token to the normal grammar.
Operator
Supported operator prefixes.
PageDirection
Page motion direction.
ParagraphDirection
Paragraph motion direction.
QuitPolicy
Quit behavior for commands that may discard changes.
SearchCaseSensitivity
Case policy for a submitted search query.
SearchDirection
Direction for literal search.
SearchOutcome
Outcome from submitting or repeating a search.
ViewportPosition
Supported cursor-relative viewport positions.
VimAction
Editor action resolved from grammar, maps, or leader bindings.
VimCommand
Supported Vim editor commands.
VimError
Vim-compatible errors shown on the command/status line.
VimMode
High-level editing mode for the Vim controller.
VimStatusMessage
A bottom-line Vim status message.
VisualGrammarOutput
Visual grammar output.
VisualMode
Supported visual selection variants.
WordKind
Vim word families.
WriteQuitPolicy
Write behavior for commands that write and quit.

Constants§

DEFAULT_MAX_FILE_BYTES
Maximum file size accepted by default when opening editor buffers.

Functions§

apply_search_outcome
Applies a search outcome.
run
Runs the Alma Bevy application.
run_headless
Runs the Alma editor dataflow without windowing or rendering plugins.

Type Aliases§

VimSearchState
Bevy resource wrapper for Vim search state.