Skip to main content

Module prelude

Module prelude 

Source
Expand description

The types you almost always want, in one glob (includes the core prelude).

Re-exports§

pub use crate::diagnostics;
pub use crate::diagnostics;
pub use crate::serve;
pub use crate::serve_on;
pub use crate::CompletionFn;
pub use crate::DefinitionFn;
pub use crate::DescribeFn;
pub use crate::DiagnosticsOptions;
pub use crate::Document;
pub use crate::Documents;
pub use crate::ExtraDiagnosticsFn;
pub use crate::FailedNode;
pub use crate::HoverFn;
pub use crate::LabelFn;
pub use crate::Language;
pub use crate::LineIndex;
pub use crate::NodeLabel;
pub use crate::PositionEncoding;
pub use crate::SimpleLanguage;
pub use crate::SymbolsFn;

Structs§

CancelToken
A cheap, thread-safe flag for cancelling an engine run.
Engine
The multi-pass fixpoint driver.
EngineConfig
Tunables for an Engine.
Job
One ready node prepared for execution by a round.
NodeId
A stable identifier for a node within a ParseTree.
ParseTree
A tree of source regions grown by the Engine.
RunReport
Summary of a single Engine::run.
Schedule
An ordered sequence of passes, indexed by round.
SerialExecutor
An Executor that runs jobs one at a time on the calling thread.
Session
A long-lived document: a ParseTree that can absorb Edits.
Span
A half-open byte range [start, end) into a source text, tagged with the revision of that text it refers to.
StatusCounts
Per-status node counts for a whole tree.
Violation
One rejected child region: what a pass tried to produce and why the engine refused it.

Enums§

Outcome
What a Pass instructs the engine to do with a node.
Status
Lifecycle state of a node in a ParseTree.
ViolationKind
The reason a produced child region was rejected. See Violation.

Traits§

Executor
Runs a batch of jobs, possibly in parallel.
Pass
One stage of a parse schedule.

Functions§

pass_fn
Creates a pass from a closure — no struct, no impl block.
run
Parses source from scratch with passes and returns the settled tree plus the run report — the quickest way to try a schedule out, in a test, a doctest, or a first experiment: