Packages

c

laika.io.ops

TreeMapperOps

abstract class TreeMapperOps[F[_]] extends AnyRef

Operations for builders of transformers that allow to modify the tree or documents between parsing and rendering.

This hook differs from the rewrite rules in two ways: first it does not only operate on the AST nodes of a document, therefore it can also change its path or config. Secondly it allows for effectful transformations which are not available in the pure laika-core module.

Linear Supertypes
AnyRef, Any
Known Subclasses
Builder, Builder, TreeProcessorBuilder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TreeMapperOps
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TreeMapperOps()(implicit arg0: Sync[F])

Type Members

  1. abstract type MapRes

Abstract Value Members

  1. abstract def evalMapTree(f: (ParsedTree[F]) ⇒ F[ParsedTree[F]]): MapRes

    Creates a new transformer that applies the specified effectful function to the parsed tree before rendering.

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. val F: Sync[F]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def evalMapDocuments(f: (Document) ⇒ F[Document]): MapRes

    Creates a new transformer that applies the specified effectful function to each document in the parsed tree before rendering.

  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def mapDocuments(f: (Document) ⇒ Document): MapRes

    Creates a new transformer that applies the specified function to each document in the parsed tree before rendering.

  15. def mapTree(f: (ParsedTree[F]) ⇒ ParsedTree[F]): MapRes

    Creates a new transformer that applies the specified function to the parsed tree before rendering.

  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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()

Inherited from AnyRef

Inherited from Any

Ungrouped