rag-base/ai.koog.rag.base.files/DocumentProvider/DocumentRange

DocumentRange

data class DocumentRange(val start: DocumentProvider.Position, val end: DocumentProvider.Position)(source)

Represents a range within a document, defined by a start and end position.

A DocumentRange encapsulates two Position objects, representing the beginning and end of the range, respectively. These positions are zero-based and valid for navigating and selecting content within a textual document.

This class provides utilities for working with document ranges, including calculating the number of lines covered by the range, determining if the range spans multiple lines, and extracting a substring from a given text based on the range.

Constructors

DocumentRange

constructor(start: DocumentProvider.Position, end: DocumentProvider.Position)

Properties

end

val end: DocumentProvider.Position

The ending position of the range (exclusive).

isMultiline

val isMultiline: Boolean

Indicates whether the range spans across multiple lines.

lines

val lines: Int

The number of lines covered by the range defined by the start and end positions. This computation includes both the start and end lines in the count.

start

val start: DocumentProvider.Position

The starting position of the range (inclusive).

Functions

substring

fun substring(text: CharSequence): String

Extracts a substring from the given text based on the start and end positions of the DocumentRange.