Packages

t

laika.io.ops

InputOps

trait InputOps[F[_]] extends AnyRef

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.

Linear Supertypes
AnyRef, Any
Known Subclasses
BinaryTreeTransformer, TreeParser, TreeTransformer
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InputOps
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Result

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

Abstract Value Members

  1. abstract def F: Async[F]
  2. abstract def config: OperationConfig

    The configuration to use for all input operations.

  3. abstract def fromInput(input: InputTreeBuilder[F]): Result

    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.

    input

    the input tree to process

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. 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.

    roots

    the root directories to traverse

    exclude

    the files to exclude from processing

    codec

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

  9. 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.

    roots

    the root directories to traverse

    codec

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

  10. 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.

    dir

    the root directory to traverse

    exclude

    the files to exclude from processing

    codec

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

  11. 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.

    dir

    the root directory to traverse

    codec

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

  12. 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.

    name

    the name of the directory to traverse

    exclude

    the files to exclude from processing

    codec

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

  13. 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.

    name

    the name of the directory to traverse

    codec

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

  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. def fromDirectory(dir: File, exclude: FileFilter)(implicit codec: Codec): Result
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) use fromDirectory(String, FileFilter) or fromDirectory(FilePath, FileFilter)

  3. def fromDirectory(dir: File)(implicit codec: Codec): Result
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) use fromDirectory(String) or fromDirectory(FilePath)

  4. def fromWorkingDirectory(exclude: FileFilter = DirectoryInput.hiddenFileFilter)(implicit codec: Codec): Result
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) use fromDirectory(String) or fromDirectory(FilePath) using a relative path

Inherited from AnyRef

Inherited from Any

Ungrouped