Struct LexIncludeHandler 

pub struct LexIncludeHandler { /* private fields */ }

Built-in handler for the lex.include label.

Implementations

impl LexIncludeHandler

pub fn new(loader: Arc<dyn Loader + Send + Sync>, config: ResolveConfig) -> Self

Construct a handler from a loader (typically crate::lex::includes::FsLoader in production, [crate::lex::includes::MemoryLoader] in tests) and a resolve config bundling the resolution root plus depth / total-include caps.

Depth and total-include limits are not enforced by the handler itself; they belong to the resolve-pass walker that wraps dispatches across the document. The handler stores the config so that future hooks (validate, render) can read its limits without an additional indirection.

pub fn root(&self) -> &Path

Read-only access to the resolution root the handler was built with. Useful for tests and for the resolve pass that wires this handler into a registry.

Trait Implementations

impl LexHandler for LexIncludeHandler

fn on_resolve(&self, ctx: &LabelCtx) -> Result<Option<WireNode>, HandlerError>

Returns an AST replacement subtree, which the host splices into the parent in place of the labelled node. Fires during the resolve phase, before analyse. Ok(None) leaves the original node in place.

fn on_label(&self, _ctx: &LabelCtx)

Informational notification fired during the analyse phase. No response is expected. Use this for handlers that maintain external state (caches, indices, link graphs).

fn on_validate(&self, _ctx: &LabelCtx) -> Result<Vec<Diagnostic>, HandlerError>

Returns diagnostics for a labelled node. Fires during analyse, after resolve.

fn on_ir_build(&self, _ctx: &LabelCtx) -> Result<Option<WireNode>, HandlerError>

Returns a typed wire node consumed by the host while building its in-memory IR from the parsed source. Fires during IR construction (from_lex), strictly after parsing and strictly before render. Ok(None) falls back to the host’s generic verbatim/annotation IR.

fn on_render( &self, _ctx: &LabelCtx, _fmt: Format, ) -> Result<Option<RenderOut>, HandlerError>

Returns the labelled node’s representation in a target format. Fires during lexd convert or library-driven rendering. Ok(None) falls back to default rendering of the underlying node.

fn on_hover(&self, _ctx: &LabelCtx) -> Result<Option<Hover>, HandlerError>

Returns hover content for a labelled node. Fires in response to textDocument/hover LSP requests.

fn on_completion( &self, _ctx: &LabelCtx, ) -> Result<Vec<Completion>, HandlerError>

Returns completion items for a position inside a labelled node’s params or body. Fires in response to textDocument/completion.

fn on_code_action( &self, _ctx: &LabelCtx, ) -> Result<Vec<CodeAction>, HandlerError>

Returns code actions for a labelled node. Fires in response to textDocument/codeAction.

fn on_format( &self, _ctx: &FormatCtx, ) -> Result<Option<LexAnnotationOut>, HandlerError>

Returns the Lex-source representation of a typed AST subtree owned by this handler’s namespace — the inverse of on_resolve, and the reverse-direction sibling of on_render for the Lex target format.