SnakeYAML Engine KMP/it.krzeminski.snakeyaml.engine.kmp.scanner/StreamReader

StreamReader

class StreamReader(loadSettings: LoadSettings, stream: Source)(source)

Reads the provided stream of code points, and implements look-ahead operations.

Checks if code points are in the allowed range. If stream contains invalid UTF-8-encoded bytes, they will be replaced with ?.

Parameters

loadSettings

configuration options

stream

the input

Constructors

StreamReader

constructor(loadSettings: LoadSettings, stream: String)

Read the provided String into a Buffer and implement look-ahead operations.

constructor(loadSettings: LoadSettings, stream: Source)

Types

Companion

object Companion

Properties

column

var column: Int

Current position as number (in characters) from the beginning of the current line

documentIndex

var documentIndex: Int

index of the current position from the beginning of the current document.

index

var index: Int

Current position as number (in characters) from the beginning stream.

line

var line: Int

Current line from the beginning of the stream.

Functions

forward

@JvmOverloads

fun forward(length: Int = 1)

Read the next length characters and move the pointer.

getMark

fun getMark(): Mark?

Generate Mark of the current position, or null if LoadSettings.useMarks is false.

peek

fun peek(): Int

Peek the next code point.

fun peek(index: Int): Int

Peek the next index-th code point.

prefix

fun prefix(length: Int): String

Create String from code points.

prefixForward

fun prefixForward(length: Int): String

prefix(length) immediately followed by forward(length)

resetDocumentIndex

fun resetDocumentIndex()

Reset the position to start (at the start of a new document in the stream)