io

Type Members

1. trait BinaryOutputOps extends OutputOps

   

   A target for a render operation that accepts only binary output.

2. trait Input extends AnyRef

   

   Represents the input for a parser, abstracting over various types of IO resources.

   Represents the input for a parser, abstracting over various types of IO resources.

   For parsers that use the parser combinators of this library, this trait offers a convenient asParserInput method. Other types of parsers may use the java.io.Reader provided by the asReader method.

3. trait InputOps extends AnyRef

   

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

   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").

4. trait InputTree extends AnyRef

   

   Represents a tree structure of Inputs, abstracting over various types of IO resources.

   Represents a tree structure of Inputs, abstracting over various types of IO resources.

   While the default implementations wrap the structure of directories in the file system, other implementations may build an entirely virtual input tree structure.

5. trait InputTreeOps extends AnyRef

   

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

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

   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 fromInputTree. Calling fromDirectory("src") for example is only a convenient shortcut for calling fromInputTree(InputTree.fromDirectory("src").

6. trait Output extends AnyRef

   

   Represents the output of a renderer, abstracting over various types of IO resources.

   Represents the output of a renderer, abstracting over various types of IO resources.

   For renderers that only need a simple way to pass Strings to the output, a simple funtion (String => Unit) is provided. Alternatively the full java.io.Writer API may be used.

   The API provided by this trait is only meant to be used internally by a renderer implementation. For providing hooks for user customization, the renderer should wrap it in a convenient API appropriate for the corresponding output format, like the HTMLWriter API for HTML renderers for example.

7. trait OutputOps extends AnyRef

   

   Base trait for various collections of output operations.

8. trait OutputTree extends AnyRef

   

   Represents a tree structure of Outputs, abstracting over various types of IO resources.

   Represents a tree structure of Outputs, abstracting over various types of IO resources.

   While the default implementations wrap the structure of directories in the file system, other implementations may build an entirely virtual output tree structure.

9. trait OutputTreeOps extends OutputOps

   

   Represents a tree of output destinations for recursive render operations.

   Represents a tree of output destinations for recursive render operations. Various types of output can be specified to trigger the actual rendering.

10. trait TextOuputOps extends BinaryOutputOps

    

    Represents a single destination for a render operation.

    Represents a single destination for a render operation. Various types of output can be specified to trigger the actual rendering.