DocumentSymbol

[Source]

class ref DocumentSymbol

Constructors

create

[Source]

new ref create(
  name': String val,
  kind': I64 val,
  range': LspPositionRange val,
  selection_range': LspPositionRange val)
: DocumentSymbol ref^

Parameters

• name': String val
• kind': I64 val
• range': LspPositionRange val
• selection_range': LspPositionRange val

Returns

• DocumentSymbol ref^

---

Public fields

let name: String val

[Source]

---

let detail: (String val | None val)

[Source]

More detail for this symbol, e.g the signature of a function.

---

let kind: I64 val

[Source]

The kind of this symbol. See SymbolKinds.

---

let tags: (Array[I64 val] ref | None val)

[Source]

Tags for this document symbol.

since 3.16.0

---

let range: LspPositionRange val

[Source]

The range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to determine if the clients cursor is inside the symbol to reveal in the symbol in the UI.

---

let selection_range: LspPositionRange val

[Source]

The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function. Must be contained by the range.

---

let children: Array[DocumentSymbol ref] ref

[Source]

Children of this symbol, e.g. properties of a class.

---

Public Functions

push_child

[Source]

fun ref push_child(
  child: DocumentSymbol ref)
: None val

Parameters

• child: DocumentSymbol ref

Returns

• None val

---

to_json

[Source]

fun box to_json()
: (F64 val | I64 val | Bool val | 
    None val | String val | JsonArray val | 
    JsonObject val)

Returns

• (F64 val | I64 val | Bool val | None val | String val | JsonArray val | JsonObject val)

---