mfm.kt/com.github.samunohito.mfm.api.parser/SubstringFoundInfo

SubstringFoundInfo

data class SubstringFoundInfo(val type: FoundType, val overallRange: IntRange, val contentRange: IntRange, val resumeIndex: Int, val nestedInfos: List<SubstringFoundInfo> = listOf())

Represents information about a found substring.

Constructors

SubstringFoundInfo

constructor(type: FoundType, info: SubstringFoundInfo)

Creates a new SubstringFoundInfo object with the specified parameters.

constructor(type: FoundType, overallRange: IntRange, contentRange: IntRange, resumeIndex: Int, nestedInfos: List<SubstringFoundInfo> = listOf())

Types

Companion

object Companion

Properties

contentRange

val contentRange: IntRange

The range of the found substring in the actual content. The "actual content" is a range that does not contain format strings (e.g. symbols like #, @, *, etc.).

nestedInfos

val nestedInfos: List<SubstringFoundInfo>

The list of nested SubstringFoundInfo objects.

overallRange

val overallRange: IntRange

The range of the found substring in the overall string. The "whole string" is the range that includes the format string (e.g. symbols such as #, @, *, etc.).

resumeIndex

val resumeIndex: Int

The restart index of the found substring. This index makes it easier to restart searches.

type

val type: FoundType

The type of the found substring.

Functions

get

operator fun get(index: ISubIndex): SubstringFoundInfo

operator fun get(index: Int): SubstringFoundInfo

Get the element at index in nestedInfos. This is to support a notation for simpler access to nestedInfos.