InputOps

API for producing a result from processing various types of input.

This is essentially a collection of shortcuts that allow any class merging in this trait to define all input related operations in terms of the only abstract method fromInput. Calling fromFile("foo.md") for example is only a convenient shortcut for calling fromInput(Input.fromFile("foo.md").

Linear Supertypes

AnyRef, Any

Known Subclasses

Parse, Transform, TransformGatheredOutput, TransformMappedOutput

Type Members

abstract type InputResult

The type of the result returned by all operations of this trait.

Abstract Value Members

abstract def fromInput(input: Input): InputResult

Returns the result from parsing the specified input.
Returns the result from parsing the specified input.
This is a generic method based on Laika's IO abstraction layer that concrete methods delegate to. Usually not used directly in application code, but might come in handy for very special requirements.
input
the input for the parser

Concrete 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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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 fromFile(file: File)(implicit codec: Codec): InputResult

Returns the result from parsing the specified file.
Returns the result from parsing the specified file. Any kind of character input is valid, including empty files.
file
the file to use as input
codec
the character encoding of the file, if not specified the platform default will be used.
def fromFile(name: String)(implicit codec: Codec): InputResult

Returns the result from parsing the file with the specified name.
Returns the result from parsing the file with the specified name. Any kind of character input is valid, including empty files.
name
the name of the file to parse
codec
the character encoding of the file, if not specified the platform default will be used.
def fromReader(reader: Reader): InputResult

Returns the result from parsing the input from the specified reader.
def fromStream(stream: InputStream)(implicit codec: Codec): InputResult

Returns the result from parsing the input from the specified stream.
Returns the result from parsing the input from the specified stream.
stream
the stream to use as input for the parser
codec
the character encoding of the stream, if not specified the platform default will be used.
def fromString(str: String): InputResult

Returns the result from parsing a the specified string.
Returns the result from parsing a the specified string. Any kind of input is valid, including an empty string.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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( ... )

Related Doc: package io

trait InputOps extends AnyRef

Type Members

abstract type InputResult

Abstract Value Members

abstract def fromInput(input: Input): InputResult

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fromFile(file: File)(implicit codec: Codec): InputResult

def fromFile(name: String)(implicit codec: Codec): InputResult

def fromReader(reader: Reader): InputResult

def fromStream(stream: InputStream)(implicit codec: Codec): InputResult

def fromString(str: String): InputResult

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped