InputOps

laika.io.ops.InputOps
trait InputOps[F[_]]

API for specifying the tree of character inputs for a parsing operation.

It allows any class merging in this trait to define all input related operations in terms of the only abstract method fromInput.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class TreeParser[F]
class TreeTransformer[F]

Members list

Type members

Types

type Result

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

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

Attributes

Value members

Abstract methods

def F: Async[F]
def config: OperationConfig

The configuration to use for all input operations.

The configuration to use for all input operations.

Attributes

Builder step that instructs the runtime to use the specified input builder for all parsing operations.

Builder step that instructs the runtime to use the specified input builder for all parsing operations.

This is the most generic way to specify the input as it allows to freely compose inputs from multiple directories, files, streams, the classpath or in-memory inputs. All other methods in this trait are mere shortcuts that delegate to this method.

Value parameters

input

the input tree to process

Attributes

Concrete methods

def fromDirectories(roots: Seq[FilePath])(implicit codec: Codec): Result

Builder step that instructs the runtime to parse files from the specified directories and its subdirectories, merging them into a tree with a single root.

Builder step that instructs the runtime to parse files from the specified directories and its subdirectories, merging them into a tree with a single root.

Value parameters

codec

the character encoding of the files, if not specified the platform default will be used.

roots

the root directories to traverse

Attributes

def fromDirectories(roots: Seq[FilePath], exclude: FileFilter)(implicit codec: Codec): Result

Builder step that instructs the runtime to parse files from the specified directories and its subdirectories, merging them into a tree with a single root.

Builder step that instructs the runtime to parse files from the specified directories and its subdirectories, merging them into a tree with a single root.

Value parameters

codec

the character encoding of the files, if not specified the platform default will be used.

exclude

the files to exclude from processing

roots

the root directories to traverse

Attributes

def fromDirectory(name: String)(implicit codec: Codec): Result

Builder step that instructs the runtime to parse files from the specified directory and its subdirectories.

Builder step that instructs the runtime to parse files from the specified directory and its subdirectories.

Value parameters

codec

the character encoding of the files, if not specified the platform default will be used.

name

the name of the directory to traverse

Attributes

def fromDirectory(name: String, exclude: FileFilter)(implicit codec: Codec): Result

Builder step that instructs the runtime to parse files from the specified directory and its subdirectories.

Builder step that instructs the runtime to parse files from the specified directory and its subdirectories.

Value parameters

codec

the character encoding of the files, if not specified the platform default will be used.

exclude

the files to exclude from processing

name

the name of the directory to traverse

Attributes

def fromDirectory(dir: FilePath)(implicit codec: Codec): Result

Builder step that instructs the runtime to parse files from the specified directory and its subdirectories.

Builder step that instructs the runtime to parse files from the specified directory and its subdirectories.

Value parameters

codec

the character encoding of the files, if not specified the platform default will be used.

dir

the root directory to traverse

Attributes

def fromDirectory(dir: FilePath, exclude: FileFilter)(implicit codec: Codec): Result

Builder step that instructs the runtime to parse files from the specified directory and its subdirectories.

Builder step that instructs the runtime to parse files from the specified directory and its subdirectories.

Value parameters

codec

the character encoding of the files, if not specified the platform default will be used.

dir

the root directory to traverse

exclude

the files to exclude from processing

Attributes

Deprecated methods

def fromDirectory(dir: File)(implicit codec: Codec): Result

Attributes

Deprecated
true
def fromDirectory(dir: File, exclude: FileFilter)(implicit codec: Codec): Result

Attributes

Deprecated
true
def fromWorkingDirectory(exclude: FileFilter)(implicit codec: Codec): Result

Attributes

Deprecated
true