Packages

sealed trait Result[+A] extends AnyRef

Data type representing either successfully computed value or non-empty collection of path-annotated errors.

A

type of success value

Since

0.7.0

See also

https://chimney.readthedocs.io/supported-transformations/#total-transformers-vs-partialtransformers

Linear Supertypes
AnyRef, Any
Known Subclasses
Errors, Value
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Result
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def asErrorPathMessages: Iterable[(String, ErrorMessage)]

    Returns (possibly empty) collection of tuples with conventional string representation of path and errors message.

    Returns (possibly empty) collection of tuples with conventional string representation of path and errors message.

    returns

    empty scala.collection.Iterable if success, a sequence of pairs (a path to a failed field, an io.scalaland.chimney.partial.ErrorMessage) otherwise

    Since

    0.7.0

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. final def asEither: Either[Errors, A]

    Converts a partial result to an scala.Either.

    Converts a partial result to an scala.Either.

    returns

    scala.Right if success, scala.Left containing io.scalaland.chimney.partial.Result.Errors otherwise

    Since

    0.7.0

  5. final def asEitherErrorPathMessageStrings: Either[Iterable[(String, String)], A]

    Converts a partial result to an scala.Either with collection of tuples with conventional string representation of path and string representation of error message as scala.Left.

    Converts a partial result to an scala.Either with collection of tuples with conventional string representation of path and string representation of error message as scala.Left.

    returns

    scala.Right if success, scala.Left containing a sequence of pairs (a path to a failed field, an errors message as java.lang.String otherwise

    Since

    0.8.5

  6. final def asEitherErrorPathMessages: Either[Iterable[(String, ErrorMessage)], A]

    Converts a partial result to an scala.Either with collection of tuples with conventional string representation of path and errors message as scala.Left.

    Converts a partial result to an scala.Either with collection of tuples with conventional string representation of path and errors message as scala.Left.

    returns

    scala.Right if success, scala.Left containing a sequence of pairs (a path to a failed field, an io.scalaland.chimney.partial.ErrorMessage) otherwise

    Since

    0.8.5

  7. final def asErrorPathMessageStrings: Iterable[(String, String)]

    Returns (possibly empty) collection of tuples with conventional string representation of path and string representation of error message.

    Returns (possibly empty) collection of tuples with conventional string representation of path and string representation of error message.

    returns

    empty scala.collection.Iterable if success, a sequence of pairs (a path to a failed field, an errors message as java.lang.String

    Since

    0.7.0

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. final def asOption: Option[A]

    Converts a partial result to an optional value.

    Converts a partial result to an optional value.

    returns

    scala.Some if success, scala.None otherwise

    Since

    0.7.0

  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def flatMap[B](f: (A) ⇒ Result[B]): Result[B]

    Builds a new result by applying a function to a success value and using result returned by that that function.

    Builds a new result by applying a function to a success value and using result returned by that that function.

    B

    the element type of the returned result

    f

    the function to apply to a success value

    returns

    a new io.scalaland.chimney.partial.Result built from applying a function to a success value and using the io.scalaland.chimney.partial.Result returned by that function

    Since

    0.7.0

  15. final def flatten[B](implicit ev: <:<[A, Result[B]]): Result[B]

    Builds a new result by flattening the current value.

    Builds a new result by flattening the current value.

    B

    the element type of the returned result

    returns

    a new io.scalaland.chimney.partial.Result built from applying a function to a success value and using the io.scalaland.chimney.partial.Result returned by that function

    Since

    0.8.4

  16. final def fold[B](onValue: (A) ⇒ B, onErrors: (Errors) ⇒ B): B

    Extracts value from a partial result and applies it to the appropriate function.

    Extracts value from a partial result and applies it to the appropriate function.

    B

    the type of the folding

    onValue

    the function to apply to success value

    onErrors

    the function to apply to errors

    returns

    a new value

    Since

    0.8.5

  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def map[B](f: (A) ⇒ B): Result[B]

    Builds a new result by applying a function to a success value.

    Builds a new result by applying a function to a success value.

    B

    the element type of the returned result

    f

    the function to apply to a success value

    returns

    a new io.scalaland.chimney.partial.Result built from applying a function to a success value

    Since

    0.7.0

  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def orElse[B >: A](result: ⇒ Result[B]): Result[B]

    Prepends a io.scalaland.chimney.partial.PathElement to all errors represented by this result.

    Prepends a io.scalaland.chimney.partial.PathElement to all errors represented by this result.

    B

    the element type of the returned result

    result

    lazy io.scalaland.chimney.partial.Result to compute as a fallback if this one has errors

    returns

    a io.scalaland.chimney.partial.Result with the first successful value or a failure combining errors from both results

    Since

    1.0.0

  25. final def prependErrorPath(pathElement: ⇒ PathElement): Result.this.type

    Prepends a io.scalaland.chimney.partial.PathElement to all errors represented by this result.

    Prepends a io.scalaland.chimney.partial.PathElement to all errors represented by this result.

    pathElement

    io.scalaland.chimney.partial.PathElement to be prepended

    returns

    a io.scalaland.chimney.partial.Result with io.scalaland.chimney.partial.PathElement prepended to all errors

    Since

    0.7.0

  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped