Class/Object

scodec

Attempt

Related Docs: object Attempt | package scodec

Permalink

sealed abstract class Attempt[+A] extends Product with Serializable

Right biased Either[Err, A].

An Attempt is either an Attempt.Successful or an Attempt.Failure. Attempts can be created by calling Attempt.successful or Attempt.failure, as well as converting from an Option via fromOption.

Source
Attempt.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Attempt
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by TransformSyntax
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean

    Permalink
    Definition Classes
    Equals
  2. abstract def flatMap[B](f: (A) ⇒ Attempt[B]): Attempt[B]

    Permalink

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

  3. abstract def flatten[B](implicit ev: <:<[A, Attempt[B]]): Attempt[B]

    Permalink

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

  4. abstract def fold[B](ifFailure: (Err) ⇒ B, ifSuccessful: (A) ⇒ B): B

    Permalink

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

  5. abstract def getOrElse[B >: A](default: ⇒ B): B

    Permalink

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

  6. abstract def isSuccessful: Boolean

    Permalink

    True if attempt was successful.

  7. abstract def map[B](f: (A) ⇒ B): Attempt[B]

    Permalink

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

  8. abstract def mapErr(f: (Err) ⇒ Err): Attempt[A]

    Permalink

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

  9. abstract def orElse[B >: A](fallback: ⇒ Attempt[B]): Attempt[B]

    Permalink

    Returns this attempt if successful, otherwise the fallback attempt.

  10. abstract def productArity: Int

    Permalink
    Definition Classes
    Product
  11. abstract def productElement(n: Int): Any

    Permalink
    Definition Classes
    Product
  12. abstract def recover[B >: A](f: PartialFunction[Err, B]): Attempt[B]

    Permalink

    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.

  13. abstract def recoverWith[B >: A](f: PartialFunction[Err, Attempt[B]]): Attempt[B]

    Permalink

    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.

  14. abstract def require: A

    Permalink

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

  15. abstract def toEither: Either[Err, A]

    Permalink

    Converts to an either.

  16. abstract def toOption: Option[A]

    Permalink

    Converts to an option, discarding the error value.

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attempt[A] to any2stringadd[Attempt[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Attempt[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attempt[A] to ArrowAssoc[Attempt[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def as[B](implicit as: Transformer[A, B]): Attempt[B]

    Permalink

    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 Attempt[A] 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

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def ensuring(cond: (Attempt[A]) ⇒ Boolean, msg: ⇒ Any): Attempt[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attempt[A] to Ensuring[Attempt[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (Attempt[A]) ⇒ Boolean): Attempt[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attempt[A] to Ensuring[Attempt[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): Attempt[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attempt[A] to Ensuring[Attempt[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): Attempt[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attempt[A] to Ensuring[Attempt[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def exmap[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ Attempt[A]): Attempt[B]

    Permalink

    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 Attempt[A] 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 exmapc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ Attempt[A]): Attempt[B]

    Permalink

    Curried version of exmap.

    Curried version of exmap.

    Implicit information
    This member is added by an implicit conversion from Attempt[A] 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
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attempt[A] to StringFormat[Attempt[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. def isFailure: Boolean

    Permalink

    True if attempt was not successful.

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): Attempt[B]

    Permalink

    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 Attempt[A] 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
  24. def narrowc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ A): Attempt[B]

    Permalink

    Curried version of narrow.

    Curried version of narrow.

    Implicit information
    This member is added by an implicit conversion from Attempt[A] 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
  25. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. def productIterator: Iterator[Any]

    Permalink
    Definition Classes
    Product
  29. def productPrefix: String

    Permalink
    Definition Classes
    Product
  30. val self: Attempt[A]

    Permalink

    Supports TransformSyntax.

    Supports TransformSyntax.

    Implicit information
    This member is added by an implicit conversion from Attempt[A] 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
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  32. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  33. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def widen[B](f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): Attempt[B]

    Permalink

    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 Attempt[A] 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. def widenOpt[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): Attempt[B]

    Permalink

    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 Attempt[A] 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
  38. def widenOptc[B](f: (A) ⇒ B)(g: (B) ⇒ Option[A]): Attempt[B]

    Permalink

    Curried version of widenOpt.

    Curried version of widenOpt.

    Implicit information
    This member is added by an implicit conversion from Attempt[A] 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
  39. def widenc[B](f: (A) ⇒ B)(g: (B) ⇒ Attempt[A]): Attempt[B]

    Permalink

    Curried version of widen.

    Curried version of widen.

    Implicit information
    This member is added by an implicit conversion from Attempt[A] 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
  40. def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): Attempt[B]

    Permalink

    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 Attempt[A] 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
  41. def xmapc[B](f: (A) ⇒ B)(g: (B) ⇒ A): Attempt[B]

    Permalink

    Curried version of xmap.

    Curried version of xmap.

    Implicit information
    This member is added by an implicit conversion from Attempt[A] 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
  42. def [B](y: B): (Attempt[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attempt[A] to ArrowAssoc[Attempt[A]] 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]

    Permalink

    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 Attempt[A] 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 Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

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

Inherited by implicit conversion any2stringadd from Attempt[A] to any2stringadd[Attempt[A]]

Inherited by implicit conversion StringFormat from Attempt[A] to StringFormat[Attempt[A]]

Inherited by implicit conversion Ensuring from Attempt[A] to Ensuring[Attempt[A]]

Inherited by implicit conversion ArrowAssoc from Attempt[A] to ArrowAssoc[Attempt[A]]

Basic Combinators

Members