trait LogTreeSyntax[Annotation] extends AnyRef
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
- Alphabetic
- By Inheritance
- LogTreeSyntax
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
implicit
class
AnnotationsSyntax[V] extends AnyRef
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]
-
implicit
class
BooleanSyntax extends AnyRef
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 ofmyBoolean
. -
implicit
class
BranchLabelingSyntax extends AnyRef
Syntax for labeling or creating new branches in a log tree given a description.
- type DescribedComputation[V] = EitherT[LogTreeWriter, String, V]
-
implicit
class
DisjunctionSyntax[V] extends AnyRef
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 ofmyEither
. -
implicit
class
EitherSyntax[V] extends AnyRef
Syntax for treating
scala.Either
as signifiers of success or failure in a computation.Syntax for treating
scala.Either
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 ofmyEither
. - implicit class FoldSyntax[V] extends AnyRef
-
implicit
class
LabellingSyntax[V] extends AnyRef
Syntax for labeling root nodes of trees in
DescribedComputions
-
implicit
class
LeafSyntax[V] extends AnyRef
Syntax for lifting values into
DescribedComputations
and creating leaf nodes in the log tree. - implicit class LeftDisjunctionSyntax[E, V] extends AnyRef
- type LogTree = Tree[LogTreeLabel[Annotation]]
- type LogTreeWriter[V] = WriterT[scalaz.Id.Id, LogTree, V]
- implicit class MaybeSyntax[V] extends AnyRef
-
implicit
class
OptionSyntax[V] extends AnyRef
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 ofmyOption
. - type SerializableDescribedComputation[V] = (\/[String, V], SerializableTree[Annotation])
-
implicit
class
TraversableMonadSyntax[F[_], V] extends AnyRef
Syntax for dealing with traversable monads
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
failure[V](description: String): DescribedComputation[V]
Create a treelog.LogTreeSyntax.DescribedComputation representing a failure using the given
description
for both the log tree label and as the content of thevalue
, which will be a scalaz.-\/. - def failureLog[V](dc: DescribedComputation[V]): DescribedComputation[V]
- def fromSerializableForm[V](sdc: SerializableDescribedComputation[V]): DescribedComputation[V]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- implicit val logTreeMonoid: Monoid[LogTree] { val zero: LogTreeSyntax.this.LogTree }
- implicit def logTreeShow(implicit annotationShow: Show[Annotation]): Show[LogTree]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
success[V](value: V): DescribedComputation[V]
Create a treelog.LogTreeSyntax.DescribedComputation representing a success with the given
value
(lifted into a scalaz.\/-) and no description. -
def
success[V](value: V, description: String): DescribedComputation[V]
Create a treelog.LogTreeSyntax.DescribedComputation representing a success with the given
value
(lifted into a scalaz.\/-) and the givendescription
in the log tree. -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- def toSerializableForm[V](dc: DescribedComputation[V]): SerializableDescribedComputation[V]
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )