sealed abstract class Checked[+A, +N, +R] extends Product with Serializable

A monad for aborting and non-aborting errors. Non-aborting errors are accumulated in a cats.data.Chain until the first aborting error is hit. You can think of com.digitalasset.canton.util.Checked as an extension of Either to also support errors that should not cause the computation to abort.

A

Type of aborting errors

N

Type of non-aborting errors

R

Result type of the monad

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Known Subclasses
Abort, Result
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Checked
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def nonaborts: Chain[N]
  3. abstract def productArity: Int
    Definition Classes
    Product
  4. abstract def productElement(n: Int): Any
    Definition Classes
    Product

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. def abortFlatMap[AA, NN >: N, RR >: R](f: (A) => Checked[AA, NN, RR]): Checked[AA, NN, RR]
  5. def ap[AA >: A, NN >: N, RR](f: Checked[AA, NN, (R) => RR]): Checked[AA, NN, RR]

    Applicative operation.

    Applicative operation. Consistent with the monadic flatMap according to Cats' laws, i.e.,

    x.ap(f) = for { g <- f; y <- x } yield g(x)
  6. def appendNonabort[NN >: N](nonabort: NN): Checked[A, NN, R]
  7. def appendNonaborts[NN >: N](nonaborts: Chain[NN]): Checked[A, NN, R]
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def biflatMap[AA, NN >: N, RR](f: (A) => Checked[AA, NN, RR], g: (R) => Checked[AA, NN, RR]): Checked[AA, NN, RR]
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def exists(pred: (R) => Boolean): Boolean
  14. def flatMap[AA >: A, NN >: N, RR](f: (R) => Checked[AA, NN, RR]): Checked[AA, NN, RR]
  15. def fold[B](f: (A, Chain[N]) => B, g: (Chain[N], R) => B): B
  16. def forall(pred: (R) => Boolean): Boolean
  17. def foreach(f: (R) => Unit): Unit
  18. def getAbort: Option[A]
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def getResult: Option[R]
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def isAbort: Boolean
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def isResult: Boolean
  25. def map[RR](f: (R) => RR): Checked[A, N, RR]
  26. def mapAbort[AA](f: (A) => AA): Checked[AA, N, R]
  27. def mapNonabort[NN](f: (N) => NN): Checked[A, NN, R]
  28. def mapNonaborts[NN](f: (Chain[N]) => Chain[NN]): Checked[A, NN, R]
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. def prependNonabort[NN >: N](nonabort: NN): Checked[A, NN, R]
  33. def prependNonaborts[NN >: N](nonaborts: Chain[NN]): Checked[A, NN, R]
  34. def product[AA >: A, NN >: N, RR](other: Checked[AA, NN, RR]): Checked[AA, NN, (R, RR)]

    Applicative product operation.

    Applicative product operation. Errors from this take precedence over other

  35. def productElementName(n: Int): String
    Definition Classes
    Product
  36. def productElementNames: Iterator[String]
    Definition Classes
    Product
  37. def productIterator: Iterator[Any]
    Definition Classes
    Product
  38. def productPrefix: String
    Definition Classes
    Product
  39. def reverseAp[AA >: A, NN >: N, RR](f: Checked[AA, NN, (R) => RR]): Checked[AA, NN, RR]

    Reverse applicative operation.

    Reverse applicative operation. Errors from the argument (= this) take precedence over those from the function.

  40. def successful: Boolean

    Is a Checked.Result with no errors

  41. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  42. def toEither: Either[A, R]

    Discards nonaborts.

  43. def toEitherMergeNonaborts[L >: N](implicit ev: <:<[A, NonEmptyChain[L]]): Either[NonEmptyChain[L], R]

    Discards the result if there are nonaborts.

  44. def toEitherWithNonaborts[L, A1 >: A <: L, N1 >: N <: L]: Either[NonEmptyChain[L], R]

    Discards the result if there are nonaborts.

  45. def toOption: Option[R]
  46. def toResult[NN, RR >: R, A1 >: A <: NN, N1 >: N <: NN](default: => RR): Checked[Nothing, NN, RR]

    Merges aborts with nonaborts, using the given default result if no result is contained.

  47. def toString(): String
    Definition Classes
    AnyRef → Any
  48. def traverse[F[_], AA >: A, NN >: N, RR](f: (R) => F[RR])(implicit F: Applicative[F]): F[Checked[AA, NN, RR]]

    When Checked.Result, apply the function, marking the result as Checked.Result inside the Applicative's context, keeping the warnings.

    When Checked.Result, apply the function, marking the result as Checked.Result inside the Applicative's context, keeping the warnings. when Checked.Abort, lift the Checked.Abort into the Applicative's context

  49. def trimap[AA, NN, RR](abortMap: (A) => AA, nonabortMap: (N) => NN, resultMap: (R) => RR): Checked[AA, NN, RR]
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  52. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped