LogTreeSyntax
See the treelog package documentation for a brief introduction to treelog and also, examples on GitHub to get started.
See the treelog package documentation for a brief introduction to treelog and also, examples on GitHub to get started.
This trait provides syntax for manipulating DescribedComputations. Either:
-
extend this trait, or
-
define an object with the appropriate Annotation type and import on demand
Type members
Classlikes
Syntax for allowing annotations to be added to log tree nodes.
Syntax for allowing annotations to be added to log tree nodes.
The best way to see how this syntax works is to take a look at the annotations example on GitHub.
Here is a short example:
import scalaz.syntax.show._
val syntax = new LogTreeSyntax[String] {}
import syntax._
val result = 1 ~> "One" ~~ Set("Annotating with a string", "And another")
println(result.run.value)
// Will print: \/-(1) - note that the 'right' means ''success''
println(result.run.written.shows)
// Will print:
// One - [Annotating with a string, And another]
Syntax for treating booleans as indicators of success or failure in a computation.
Syntax for treating booleans as indicators of success or failure in a computation.
The simplest usage is something like: myBoolean ~>? "Is my boolean true?". The 'value'
and log tree of the returned treelog.LogTreeSyntax.DescribedComputation will indicate success or failure
depending on the value of myBoolean.
Syntax for labeling or creating new branches in a log tree given a description.
Syntax for labeling or creating new branches in a log tree given a description.
Syntax for treating scalaz.\/ as signifiers of success or failure in a computation.
Syntax for treating scalaz.\/ as signifiers of success or failure in a computation.
The simplest usage is something like: myEither ~>? "Do I have the right?". The 'value'
and log tree of the returned treelog.LogTreeSyntax.DescribedComputation will indicate success or failure
depending on the value of myEither.
Syntax for labeling root nodes of trees in DescribedComputions
Syntax for labeling root nodes of trees in DescribedComputions
Syntax for lifting values into DescribedComputations and creating leaf nodes in the log tree.
Syntax for lifting values into DescribedComputations and creating leaf nodes in the log tree.
Syntax for treating Options as indicators of success or failure in a computation.
Syntax for treating Options as indicators of success or failure in a computation.
The simplest usage is something like: myOption ~>? "Do I have Some?". The 'value'
and log tree of the returned treelog.LogTreeSyntax.DescribedComputation will indicate success or failure
depending on the value of myOption.
Syntax for dealing with traversable monads
Syntax for dealing with traversable monads
Types
Value members
Concrete methods
Create a treelog.LogTreeSyntax.DescribedComputation representing a failure using the given description for both the log tree label and as
the content of the value, which will be a Left.
Create a treelog.LogTreeSyntax.DescribedComputation representing a failure using the given description for both the log tree label and as
the content of the value, which will be a Left.
Create a treelog.LogTreeSyntax.DescribedComputation representing a success with the given value (lifted into a Right) and the given
description in the log tree.
Create a treelog.LogTreeSyntax.DescribedComputation representing a success with the given value (lifted into a Right) and the given
description in the log tree.
Create a treelog.LogTreeSyntax.DescribedComputation representing a success with the given value (lifted into a Right) and no
description.
Create a treelog.LogTreeSyntax.DescribedComputation representing a success with the given value (lifted into a Right) and no
description.