KTreeSitter/io.github.treesitter.ktreesitter/QueryCursor

QueryCursor

actual class QueryCursor : AutoCloseable(source)

A class that is used for executing a query.

NOTE: If you're targeting Android SDK level < 33, you must use or close the instance to free up resources.

Since

0.25.0

expect class QueryCursor(source)

A class that is used for executing a query.

Since

0.25.0

actual class QueryCursor(source)

A class that is used for executing a query.

Since

0.25.0

actual class QueryCursor(source)

A class that is used for executing a query.

Since

0.25.0

Properties

byteRange

actual var byteRange: UIntRange

The range of bytes in which the query will be executed.

expect var byteRange: UIntRange

The range of bytes in which the query will be executed.

actual var byteRange: UIntRange

The range of bytes in which the query will be executed.

actual var byteRange: UIntRange

The range of bytes in which the query will be executed.

didExceedMatchLimit

@get:JvmName(name = "didExceedMatchLimit")

actual val didExceedMatchLimit: Boolean

Check if the query exceeded its maximum number of in-progress matches during its last execution.

expect val didExceedMatchLimit: Boolean

Check if the cursor exceeded its maximum number of in-progress matches during its last execution.

@get:JvmName(name = "didExceedMatchLimit")

actual val didExceedMatchLimit: Boolean

Check if the query exceeded its maximum number of in-progress matches during its last execution.

actual val didExceedMatchLimit: Boolean

Check if the query exceeded its maximum number of in-progress matches during its last execution.

matchLimit

@get:JvmName(name = "getMatchLimit")

@set:JvmName(name = "setMatchLimit")

actual var matchLimit: UInt

The maximum number of in-progress matches.

expect var matchLimit: UInt

The maximum number of in-progress matches.

@get:JvmName(name = "getMatchLimit")

@set:JvmName(name = "setMatchLimit")

actual var matchLimit: UInt

The maximum number of in-progress matches.

actual var matchLimit: UInt

The maximum number of in-progress matches.

maxStartDepth

@get:JvmName(name = "getMaxStartDepth")

@set:JvmName(name = "setMaxStartDepth")

actual var maxStartDepth: UInt

The maximum start depth for the query.

expect var maxStartDepth: UInt

The maximum start depth for the query.

@get:JvmName(name = "getMaxStartDepth")

@set:JvmName(name = "setMaxStartDepth")

actual var maxStartDepth: UInt

The maximum start depth for the query.

actual var maxStartDepth: UInt

The maximum start depth for the query.

pointRange

actual var pointRange: ClosedRange<Point>

The range of points in which the query will be executed.

expect var pointRange: ClosedRange<Point>

The range of points in which the query will be executed.

actual var pointRange: ClosedRange<Point>

The range of points in which the query will be executed.

actual var pointRange: ClosedRange<Point>

The range of points in which the query will be executed.

timeoutMicros

@get:JvmName(name = "getTimeoutMicros")

@set:JvmName(name = "setTimeoutMicros")

actual var ~~timeoutMicros~~: ULong

The maximum duration in microseconds that query execution should be allowed to take before halting.

expect var ~~timeoutMicros~~: ULong

The maximum duration in microseconds that query execution should be allowed to take before halting.

@get:JvmName(name = "getTimeoutMicros")

@set:JvmName(name = "setTimeoutMicros")

actual var ~~timeoutMicros~~: ULong

The maximum duration in microseconds that query execution should be allowed to take before halting.

actual var ~~timeoutMicros~~: ULong

The maximum duration in microseconds that query execution should be allowed to take before halting.

Functions

captures

@JvmOverloads

actual fun captures(predicate: QueryPredicate.(QueryMatch) -> Boolean): Sequence<Pair<UInt, QueryMatch>>

Iterate over all the individual captures in the order that they appear.

expect fun captures(predicate: QueryPredicate.(QueryMatch) -> Boolean = { true }): Sequence<Pair<UInt, QueryMatch>>

Iterate over all the individual captures in the order that they appear.

@JvmOverloads

actual fun captures(predicate: QueryPredicate.(QueryMatch) -> Boolean): Sequence<Pair<UInt, QueryMatch>>

Iterate over all the individual captures in the order that they appear.

actual fun captures(predicate: QueryPredicate.(QueryMatch) -> Boolean): Sequence<Pair<UInt, QueryMatch>>

Iterate over all the individual captures in the order that they appear.

open override fun close()

matches

@JvmOverloads

actual fun matches(predicate: QueryPredicate.(QueryMatch) -> Boolean): Sequence<QueryMatch>

Iterate over all the matches in the order that they were found.

expect fun matches(predicate: QueryPredicate.(QueryMatch) -> Boolean = { true }): Sequence<QueryMatch>

Iterate over all the matches in the order that they were found.

@JvmOverloads

actual fun matches(predicate: QueryPredicate.(QueryMatch) -> Boolean): Sequence<QueryMatch>

Iterate over all the matches in the order that they were found.

actual fun matches(predicate: QueryPredicate.(QueryMatch) -> Boolean): Sequence<QueryMatch>

Iterate over all the matches in the order that they were found.

toString

open override fun toString(): String