TreeSitterQueryCursor class final

Stateful range configuration for Tree-sitter query execution.

Like native TSQueryCursor, setting a byte range clears the point range and vice versa. An end byte of zero, or an end point of (0, 0), means an unbounded end. A zero-width nonzero range selects matches intersecting that source position.

Properties

didExceedMatchLimit bool
no setter
hashCode int
The hash code for this object.
no setterinherited
isDisposed bool
no setter
matchLimit int
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
timeoutMicros int
no setter

Methods

captures(TreeSitterQuery query, TreeSitterNode node, {String? source, TreeSitterQueryTextProvider? textProvider}) List<TreeSitterQueryCapture>
captureStream(TreeSitterQuery query, TreeSitterNode node, {required String source}) TreeSitterQueryCaptureStream
Creates a one-shot, lazy capture iterator.
capturesWithOptions(TreeSitterQuery query, TreeSitterNode node, TreeSitterQueryCursorOptions options, {String? source, TreeSitterQueryTextProvider? textProvider}) List<TreeSitterQueryCapture>
clearRange() TreeSitterQueryCursor
dispose() → void
Releases managed cursor state, matching ts_query_cursor_delete.
intoRaw() TreeSitterRawHandle<TreeSitterQueryCursor>
Moves cursor configuration and execution status into a one-shot handle.
matches(TreeSitterQuery query, TreeSitterNode node, {String? source, TreeSitterQueryTextProvider? textProvider}) List<TreeSitterQueryMatch>
matchesWithOptions(TreeSitterQuery query, TreeSitterNode node, TreeSitterQueryCursorOptions options, {String? source, TreeSitterQueryTextProvider? textProvider}) List<TreeSitterQueryMatch>
matchStream(TreeSitterQuery query, TreeSitterNode node, {required String source}) TreeSitterQueryMatchStream
Creates a one-shot, lazy match iterator.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setByteRange(int startByte, int endByte) TreeSitterQueryCursor
setMatchLimit(int matchLimit) TreeSitterQueryCursor
setMaxStartDepth(int? maxStartDepth) TreeSitterQueryCursor
setPointRange(TreeSitterPoint startPoint, TreeSitterPoint endPoint) TreeSitterQueryCursor
setTimeoutMicros(int timeoutMicros) TreeSitterQueryCursor
toString() String
A string representation of this object.
inherited
trySetByteRange(int startByte, int endByte) bool
Native boolean-returning counterpart of ts_query_cursor_set_byte_range.
trySetPointRange(TreeSitterPoint startPoint, TreeSitterPoint endPoint) bool
Native boolean-returning counterpart of ts_query_cursor_set_point_range.

Operators

operator ==(Object other) bool
The equality operator.
inherited