Class OutlineToolResult
The structured result of Outline: a ModuleOutline, with 1-based ranges and the path of the document from the workspace root.
public sealed record OutlineToolResult : OutlinedModule, IEquatable<OutlinedModule>, IEquatable<OutlineToolResult>
- Inheritance
-
OutlineToolResult
- Implements
- Inherited Members
Constructors
OutlineToolResult()
An outline with no facts set: the one a reader fills.
public OutlineToolResult()
Properties
Entries
The declarations of the module, at most OutlineEntries of them.
public IReadOnlyList<ToolOutlineEntry> Entries { get; init; }
Property Value
Path
The document: a path relative to the workspace root, or absolute when it is outside it.
public required string Path { get; init; }
Property Value
Total
How many declarations the module has, their members not counted.
public int Total { get; init; }
Property Value
Truncated
Whether Entries is cut at its cap.
public bool Truncated { get; init; }
Property Value
Methods
Of(string, ModuleOutline)
The result of the tool for an answer of rdcore/semantics/outline, its declarations cut at OutlineEntries.
public static OutlineToolResult Of(string workspaceRoot, ModuleOutline outline)
Parameters
workspaceRootstringThe root of the workspace, which the path is said from.
outlineModuleOutlineThe answer.