scodec.Attempt

Failure

final case class Failure(cause: Err) extends Attempt[Nothing] with Product with Serializable

Failed attempt.

Source
Attempt.scala
Linear Supertypes
Attempt[Nothing], Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. Failure
  2. Attempt
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
Implicitly
  1. by TransformSyntax
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Failure(cause: Err)

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Failure to any2stringadd[Failure] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Failure, B)

    Implicit information
    This member is added by an implicit conversion from Failure to ArrowAssoc[Failure] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  6. def as[B](implicit as: Transformer[A, B]): Attempt[B]

    Transforms using implicitly available evidence that such a transformation is possible.

    Transforms using implicitly available evidence that such a transformation is possible.

    Typical transformations include converting:

    • an F[L] for some L <: HList to/from an F[CC] for some case class CC, where the types in the case class are aligned with the types in L
    • an F[C] for some C <: Coproduct to/from an F[SC] for some sealed class SC, where the component types in the coproduct are the leaf subtypes of the sealed class.
    Implicit information
    This member is added by an implicit conversion from Failure to TransformSyntax[Attempt, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Attempt] is in scope.
    Definition Classes
    TransformSyntax

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. val cause: Err

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def ensuring(cond: (Failure) ⇒ Boolean, msg: ⇒ Any): Failure

    Implicit information
    This member is added by an implicit conversion from Failure to Ensuring[Failure] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: (Failure) ⇒ Boolean): Failure

    Implicit information
    This member is added by an implicit conversion from Failure to Ensuring[Failure] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean, msg: ⇒ Any): Failure

    Implicit information
    This member is added by an implicit conversion from Failure to Ensuring[Failure] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean): Failure

    Implicit information
    This member is added by an implicit conversion from Failure to Ensuring[Failure] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def exmap[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ Attempt[A]): Attempt[B]

    Transforms using two functions, A => Attempt[B] and B => Attempt[A].

    Transforms using two functions, A => Attempt[B] and B => Attempt[A].

    Implicit information
    This member is added by an implicit conversion from Failure to TransformSyntax[Attempt, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Attempt] is in scope.
    Definition Classes
    TransformSyntax

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. def flatMap[B](f: (Nothing) ⇒ Attempt[B]): Attempt[B]

    Maps the supplied function over the successful value, if present.

    Maps the supplied function over the successful value, if present.

    Definition Classes
    Failure → Attempt

  18. def flatten[B](implicit ev: <:<[Nothing, Attempt[B]]): Attempt[B]

    Converts an Attempt[Attempt[X]] in to an Attempt[X].

    Converts an Attempt[Attempt[X]] in to an Attempt[X].

    Definition Classes
    Failure → Attempt

  19. def fold[B](ifFailure: (Err) ⇒ B, ifSuccessful: (Nothing) ⇒ B): B

    Transforms this attempt to a value of type B using the supplied functions.

    Transforms this attempt to a value of type B using the supplied functions.

    Definition Classes
    Failure → Attempt

  20. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Failure to StringFormat[Failure] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  22. def getOrElse[B](default: ⇒ B): B

    Returns the sucessful value if successful, otherwise the supplied default.

    Returns the sucessful value if successful, otherwise the supplied default.

    Definition Classes
    Failure → Attempt

  23. def isFailure: Boolean

    True if attempt was not successful.

    True if attempt was not successful.

    Definition Classes
    Attempt

  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  25. def isSuccessful: Boolean

    True if attempt was successful.

    True if attempt was successful.

    Definition Classes
    Failure → Attempt

  26. def map[B](f: (Nothing) ⇒ B): Attempt[B]

    Maps the supplied function over the successful value, if present.

    Maps the supplied function over the successful value, if present.

    Definition Classes
    Failure → Attempt

  27. def mapErr(f: (Err) ⇒ Err): Attempt[Nothing]

    Maps the supplied function over the failure error, if present.

    Maps the supplied function over the failure error, if present.

    Definition Classes
    Failure → Attempt

  28. def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): Attempt[B]

    Transforms using two functions, A => Attempt[B] and B => A.

    Transforms using two functions, A => Attempt[B] and B => A.

    The supplied functions form an injection from B to A. Hence, this method converts from a larger to a smaller type. Hence, the name narrow.

    Implicit information
    This member is added by an implicit conversion from Failure to TransformSyntax[Attempt, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Attempt] is in scope.
    Definition Classes
    TransformSyntax

  29. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  30. final def notify(): Unit

    Definition Classes
    AnyRef

  31. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  32. def orElse[B](fallback: ⇒ Attempt[B]): Attempt[B]

    Returns this attempt if successful, otherwise the fallback attempt.

    Returns this attempt if successful, otherwise the fallback attempt.

    Definition Classes
    Failure → Attempt

  33. def recover[B](f: PartialFunction[Err, B]): Attempt[B]

    If this attempt is a failure, and the supplied partial function is defined for the cause of the failure, a successful attempt is returned.

    If this attempt is a failure, and the supplied partial function is defined for the cause of the failure, a successful attempt is returned. If this attempt is successful or the supplied function is not defined for the cause of the failure, this attempt is returned unmodified.

    Definition Classes
    Failure → Attempt

  34. def recoverWith[B](f: PartialFunction[Err, Attempt[B]]): Attempt[B]

    If this attempt is a failure, and the supplied partial function is defined for the cause of the failure, the result of applying that function is returned.

    If this attempt is a failure, and the supplied partial function is defined for the cause of the failure, the result of applying that function is returned. If this attempt is successful or the supplied function is not defined for the cause of the failure, this attempt is returned unmodified.

    Definition Classes
    Failure → Attempt

  35. def require: Nothing

    Returns the successful value if present; otherwise throws an IllegalArgumentException.

    Returns the successful value if present; otherwise throws an IllegalArgumentException.

    Definition Classes
    Failure → Attempt

  36. val self: Attempt[A]

    Supports TransformSyntax.

    Supports TransformSyntax.

    Implicit information
    This member is added by an implicit conversion from Failure to TransformSyntax[Attempt, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Attempt] is in scope.
    Definition Classes
    TransformSyntax

  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  38. def toEither: Left[Err, Nothing]

    Converts to an either.

    Converts to an either.

    Definition Classes
    Failure → Attempt

  39. def toOption: None.type

    Converts to an option, discarding the error value.

    Converts to an option, discarding the error value.

    Definition Classes
    Failure → Attempt

  40. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  42. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  43. def widen[B](f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): Attempt[B]

    Transforms using two functions, A => B and B => Attempt[A].

    Transforms using two functions, A => B and B => Attempt[A].

    The supplied functions form an injection from A to B. Hence, this method converts from a smaller to a larger type. Hence, the name widen.

    Implicit information
    This member is added by an implicit conversion from Failure to TransformSyntax[Attempt, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Attempt] is in scope.
    Definition Classes
    TransformSyntax

  44. def widenOpt[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): Attempt[B]

    Transforms using two functions, A => B and B => Option[A].

    Transforms using two functions, A => B and B => Option[A].

    Particularly useful when combined with case class apply/unapply. E.g., widenOpt(fa, Foo.apply, Foo.unapply).

    Implicit information
    This member is added by an implicit conversion from Failure to TransformSyntax[Attempt, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Attempt] is in scope.
    Definition Classes
    TransformSyntax

  45. def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): Attempt[B]

    Transforms using the isomorphism described by two functions, A => B and B => A.

    Transforms using the isomorphism described by two functions, A => B and B => A.

    Implicit information
    This member is added by an implicit conversion from Failure to TransformSyntax[Attempt, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Attempt] is in scope.
    Definition Classes
    TransformSyntax

  46. def →[B](y: B): (Failure, B)

    Implicit information
    This member is added by an implicit conversion from Failure to ArrowAssoc[Failure] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def pxmap[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): Attempt[B]

    Transforms using two functions, A => B and B => Option[A].

    Transforms using two functions, A => B and B => Option[A].

    Particularly useful when combined with case class apply/unapply. E.g., pxmap(fa, Foo.apply, Foo.unapply).

    Implicit information
    This member is added by an implicit conversion from Failure to TransformSyntax[Attempt, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[Attempt] is in scope.
    Definition Classes
    TransformSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 1.7.0) Use widenOpt instead

Inherited from Attempt[Nothing]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion TransformSyntax from Failure to TransformSyntax[Attempt, A]

Inherited by implicit conversion any2stringadd from Failure to any2stringadd[Failure]

Inherited by implicit conversion StringFormat from Failure to StringFormat[Failure]

Inherited by implicit conversion Ensuring from Failure to Ensuring[Failure]

Inherited by implicit conversion ArrowAssoc from Failure to ArrowAssoc[Failure]

Basic Combinators

Members