Expand description
Re-exports§
pub use search::SearchMode;searchpub use error::MinusError;pub use state::PagerState;
Modules§
- error
- Public pager error types.
- hooks
- Pager lifecycle hooks. Callbacks run synchronously and block rendering and input.
- input
- Keyboard and mouse input classification.
- screen
- Provides functions for getting analysis of the text data inside minus.
- search
search - Regex and incremental text search.
- state
- Runtime pager state.
Structs§
- Highlight
Colors - Highlight
Styles - Line
Navigation search - Source-line maps and optional alternate source-numbered pager content.
- Pager
- Sends content and configuration commands to a running pager.
- Prompt
Context - Prompt
Line - Prompt
Span - Prompt
Style - TocEntry
search - A visible outline heading and its source location.
Enums§
- Color
Depth - The maximum color depth accepted by the output terminal.
- Exit
Strategy - Determines whether exiting the pager also terminates the process.
- Line
Numbers - Controls line-number visibility and whether the user may toggle it.
- Prompt
Attribute - Prompt
Color - Prompt
Error - RunMode
- Define the modes in which minus can run
Functions§
- ansi256_
to_ rgb - Return the conventional RGB approximation of an ANSI palette entry.
- dynamic_
paging dynamic_output - Runs a pager that accepts content and configuration updates.
- dynamic_
paging_ in_ place dynamic_output - Runs the dynamic pager inside the caller’s active terminal screen buffer.
- page_
all static_output - Pages preloaded content, writing it directly when paging is unnecessary.
Type Aliases§
- Exit
Callbacks - Exit callbacks invoked in registration order.
- Layout
Renderer search - Rebuilds content and source maps for the available document width. Runs synchronously while pager state is locked; must not call pager state APIs.
- Prompt
Renderer - Runs synchronously while pager state is locked.
- Source
View Renderer search - Produces source-numbered text and its source-line map when navigation begins.