Skip to main content

Module Interface

Module Interface 

Source
Expand description

§Hover Interface

Type definitions for the Hover language feature. LSP-shaped DTOs.

Layout (one export per file, file name = identity):

  • Position::Struct - zero-based line + character offset.
  • Range::Struct - start..end Position::Struct pair.
  • HoverRequest::Struct - inbound request DTO.
  • HoverContent::Enum - PlainText / Markdown / Markup payload.
  • HoverResponse::Struct - outbound response DTO with contents list and optional Range::Struct.

Modules§

HoverContent
Tagged hover content payload. Plain-text and Markdown are the common shapes; Markup carries an optional language hint for syntax-highlighted code blocks.
HoverRequest
Inbound hover request DTO: document URI + cursor position.
HoverResponse
Outbound hover response DTO: ordered list of HoverContent::Enum plus an optional Range::Struct the hover applies to. Range is omitted in serialised form when absent.
Position
LSP-compatible position: zero-based line + character offset.
Range
Inclusive document range bounded by a start and end Position::Struct. Half-open at the end per LSP convention.