ketraterm-completion/io.github.ketraterm.completion.api/TerminalCompletionCandidate

TerminalCompletionCandidate

data class TerminalCompletionCandidate @JvmOverloads constructor(val replacementText: String, val replacementStartOffset: Int, val replacementEndOffset: Int, val source: String, val kind: TerminalCompletionCandidateKind, val displayText: String = replacementText, val detail: String = "", val score: Int = 0, val valueDomain: TerminalCompletionValueDomain = TerminalCompletionValueDomain.NONE, val matchedRanges: TerminalCompletionMatchRanges = TerminalCompletionMatchRanges.EMPTY)

Immutable completion candidate returned by TerminalCompletionEngine.

Throws

IllegalArgumentException

if text/source fields are empty, replacement offsets do not form a nonnegative ordered range, or matchedRanges do not address displayText.

Constructors

TerminalCompletionCandidate

@JvmOverloads

constructor(replacementText: String, replacementStartOffset: Int, replacementEndOffset: Int, source: String, kind: TerminalCompletionCandidateKind, displayText: String = replacementText, detail: String = "", score: Int = 0, valueDomain: TerminalCompletionValueDomain = TerminalCompletionValueDomain.NONE, matchedRanges: TerminalCompletionMatchRanges = TerminalCompletionMatchRanges.EMPTY)

Properties

detail

val detail: String

optional secondary text explaining the candidate.

displayText

val displayText: String

primary text shown in suggestion UI.

kind

val kind: TerminalCompletionCandidateKind

semantic candidate category.

matchedRanges

val matchedRanges: TerminalCompletionMatchRanges

immutable ordered UTF-16 intervals relative to displayText used by UI components to highlight matching fragments.

replacementEndOffset

val replacementEndOffset: Int

exclusive UTF-16 replacement end offset in the original request command line.

replacementStartOffset

val replacementStartOffset: Int

inclusive UTF-16 replacement start offset in the original request command line.

replacementText

val replacementText: String

text to insert into replacementStartOffset, exclusive replacementEndOffset.

score

val score: Int

source-local relevance before merging and the final fused ranking score after the merged engine returns the candidate; larger values are better in either scope.

source

val source: String

compact source label, such as spec, learned, or path.

valueDomain

val valueDomain: TerminalCompletionValueDomain

dynamic value domain for argument candidates supplied by host-owned providers.