package partial
- Alphabetic
- Public
- All
Type Members
-
trait
AsResult[F[_]] extends AnyRef
Utility allowing conversion from some type into io.scalaland.chimney.partial.Result.
Utility allowing conversion from some type into io.scalaland.chimney.partial.Result.
Should define logic what is considered successful value, what is considered failed value and how to convert it into io.scalaland.chimney.partial.Result.
- F
generic data type which should be convertible to
Resultfor all possible values
- Annotations
- @FunctionalInterface()
- Since
0.8.5
- See also
https://chimney.readthedocs.io/supported-transformations/#total-transformers-vs-partialtransformers
https://chimney.readthedocs.io/supported-transformations/#partialresult-utilities
-
final
case class
Error(message: ErrorMessage, path: Path = Path.Empty) extends Product with Serializable
Data structure for representing path-annotated error
Data structure for representing path-annotated error
- message
error message
- path
error path annotation
- Since
0.7.0
-
sealed
trait
ErrorMessage extends AnyRef
Representation of partial transformation error message
Representation of partial transformation error message
- Since
0.7.0
-
final
case class
Path(elements: List[PathElement]) extends AnyVal with Product with Serializable
Data structure for representing path in a (possibly) nested object structure.
Data structure for representing path in a (possibly) nested object structure.
- elements
list of path elements
- Since
0.7.0
-
sealed
trait
PathElement extends AnyRef
Data type for representing path element in a (possibly) nested object structure.
Data type for representing path element in a (possibly) nested object structure.
-
sealed
trait
Result[+A] extends AnyRef
Data type representing either successfully computed value or non-empty collection of path-annotated errors.
Data type representing either successfully computed value or non-empty collection of path-annotated errors.
- A
type of success value
Value Members
-
object
AsResult
Companion of io.scalaland.chimney.partial.AsResult.
Companion of io.scalaland.chimney.partial.AsResult.
- Since
0.8.5
- object Error extends Serializable
- object ErrorMessage
-
object
Path extends Serializable
Companion of io.scalaland.chimney.partial.Path
Companion of io.scalaland.chimney.partial.Path
- Since
0.7.0
-
object
PathElement
Companion of io.scalaland.chimney.partial.PathElement.
-
object
Result
Companion to io.scalaland.chimney.partial.Result.
Companion to io.scalaland.chimney.partial.Result.