Input

An immutable window into a stream of character data. The size of the window is determined by 2 methods: marked(pos) and append(chunk), which shrink and expand the window respectively. All positions used with Input are always relative to the entire stream, though only positions within the current window are valid at any given point in time.

The method marked returns a new Input which may drop all data before the marked position. Accessing data before the marked position in the returned Input is undefined and should be expected to fail in hilarious ways.

The method append is used to append new chunks of data from the stream onto the input. The Input returned by append will have all its data up-to mark removed.

Linear Supertypes

AnyRef, Any

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def append(chunk: String, last: Boolean = false): Input

Returns an Input with the chunk of data appended to the currently readable window.
Returns an Input with the chunk of data appended to the currently readable window. If last is true, then the returned Input's isLast method returns true. Any data available in the current Input, but prior to this Input's mark will not be available in the returned Input.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def charAt(i: Long): Char

Returns the character at the given position.
Returns the character at the given position. This method will do some aggressive bounds checking.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val data: String

the currently readable window into the stream
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def finished: Input

Returns a copy of this Input where isLast is true.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val isLast: Boolean

true if this window covers the end of the stream
def limit: Long

Returns the index of the first position that cannot be read.
Returns the index of the first position that cannot be read. If isLast is true, then this is the length of the stream.
val mark: Long

the position in the stream we are able to truncate data to
def marked(pos: Long): Input

Returns an Input whose mark is at the given position.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val offset: Long

the offset, in chars, of the start of data in the stream
def substring(from: Long, until: Long): String

Returns the substring between from (inclusive) and until (exclusive).
Returns the substring between from (inclusive) and until (exclusive). It is expected that mark <= from <= until <= limit.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def window: String

Returns the character data between mark and limit.
Returns the character data between mark and limit. This is equivalent to calling input.substring(input.mark, input.limit).

Related Docs: object Input | package parser

final class Input extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def append(chunk: String, last: Boolean = false): Input

final def asInstanceOf[T0]: T0

def charAt(i: Long): Char

def clone(): AnyRef

val data: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def finished: Input

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val isLast: Boolean

def limit: Long

val mark: Long

def marked(pos: Long): Input

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val offset: Long

def substring(from: Long, until: Long): String

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def window: String

Inherited from AnyRef

Inherited from Any

Ungrouped