io.scalaland.chimney.partial.Error.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of chimney_native0.5_2.13 Show documentation

Scala library for boilerplate-free data rewriting

The newest version!

package io.scalaland.chimney.partial

/** Data structure for representing path-annotated error
  *
  * @param message
  *   error message
  * @param path
  *   error path annotation
  *
  * @since 0.7.0
  */
final case class Error(message: ErrorMessage, path: Path = Path.Empty) {

  /** Returns a tuple with conventional string representation of a path and error message
    *
    * @since 0.7.0
    */
  def asErrorPathMessage: (String, ErrorMessage) = (path.asString, message)

  /** Prepends path with a given path element
    *
    * @param pathElement
    *   path element to be prepended
    * @return
    *   error with a path prepended with provided path element
    *
    * @since 0.7.0
    */
  def prependErrorPath(pathElement: PathElement): Error = Error(message, path.prepend(pathElement))
}

object Error {

  /** Empty value error with an empty path
    *
    * @since 0.7.0
    */
  final def fromEmptyValue: Error =
    Error(ErrorMessage.EmptyValue)

  /** Partial function not defined at given argument error with an empty path
    *
    * @param arg
    *   argument where partial function is not defined for
    *
    * @since 0.7.0
    */
  final def fromNotDefinedAt(arg: Any): Error =
    Error(ErrorMessage.NotDefinedAt(arg))

  /** Custom string error with an empty path
    *
    * @param message
    *   custom string error message
    *
    * @since 0.7.0
    */
  final def fromString(message: String): Error =
    Error(ErrorMessage.StringMessage(message))

  /** Throwable error with an empty path
    *
    * @param throwable
    *   custom throwable object
    *
    * @since 0.7.0
    */
  final def fromThrowable(throwable: Throwable): Error =
    Error(ErrorMessage.ThrowableMessage(throwable))
}