scala.util

Success

final case class Success[+T](value: T) extends Try[T] with Product with Serializable

Source
Try.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, Try[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Success
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Try
  7. AnyRef
  8. Any
Implicitly
  1. by try2either
  2. by any2stringadd
  3. by any2stringfmt
  4. by any2ArrowAssoc
  5. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Success(value: T)

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    Any
  3. final def ##(): Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

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

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

    Implicit information
    This member is added by an implicit conversion from Success[T] to ArrowAssoc[Success[T]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    Any
  8. def andThen[U](f: (T) ⇒ Try[U]): Try[U]

    Returns the given function applied to the value from this Success or returns this if this is a Failure.

    Returns the given function applied to the value from this Success or returns this if this is a Failure. Alias for flatMap.

    Definition Classes
    Try
  9. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown
    ClassCastException

    if the receiver object is not an instance of the erasure of type T0.

  10. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

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

    not specified by SLS as a member of AnyRef

  11. def ensuring(cond: (Success[T]) ⇒ Boolean, msg: ⇒ Any): Success[T]

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

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

    Implicit information
    This member is added by an implicit conversion from Success[T] to Ensuring[Success[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Success[T]

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

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  16. def failed: Try[Throwable]

    Completes this Try with an exception wrapped in a Success.

    Completes this Try with an exception wrapped in a Success. The exception is either the exception that the Try failed with (if a Failure) or an UnsupportedOperationException.

    Definition Classes
    SuccessTry
  17. def filter(p: (T) ⇒ Boolean): Try[T]

    Converts this to a Failure if the predicate is not satisfied.

    Converts this to a Failure if the predicate is not satisfied.

    Definition Classes
    SuccessTry
  18. def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

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

    not specified by SLS as a member of AnyRef

  19. def flatMap[U](f: (T) ⇒ Try[U]): Try[U]

    Returns the given function applied to the value from this Success or returns this if this is a Failure.

    Returns the given function applied to the value from this Success or returns this if this is a Failure.

    Definition Classes
    SuccessTry
  20. def flatten[U](implicit ev: <:<[T, Try[U]]): Try[U]

    Transforms a nested Try, ie, a Try of type Try[Try[T]], into an un-nested Try, ie, a Try of type Try[T].

    Transforms a nested Try, ie, a Try of type Try[Try[T]], into an un-nested Try, ie, a Try of type Try[T].

    Definition Classes
    SuccessTry
  21. def fold[X](fa: (Throwable) ⇒ X, fb: (T) ⇒ X): X

    Applies fa if this is a Left or fb if this is a Right.

    Applies fa if this is a Left or fb if this is a Right.

    fa

    the function to apply if this is a Left

    fb

    the function to apply if this is a Right

    returns

    the results of applying the function

    Implicit information
    This member is added by an implicit conversion from Success[T] to Either[Throwable, T] performed by method try2either in scala.util.Try.
    Definition Classes
    Either
    Example:
    1. val result: Either[Exception, Value] = possiblyFailingOperation()
      log(result.fold(
        ex => "Operation failed with " + ex,
        v => "Operation produced value: " + v
      ))
  22. def foreach[U](f: (T) ⇒ U): Unit

    Applies the given function f if this is a Success, otherwise returns Unit if this is a Failure.

    Applies the given function f if this is a Success, otherwise returns Unit if this is a Failure.

    Definition Classes
    SuccessTry
  23. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from Success[T] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. def get: T

    Returns the value from this Success or throws the exception if this is a Failure.

    Returns the value from this Success or throws the exception if this is a Failure.

    Definition Classes
    SuccessTry
  25. final def getClass(): Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  26. def getOrElse[U >: T](default: ⇒ U): U

    Returns the value from this Success or the given default argument if this is a Failure.

    Returns the value from this Success or the given default argument if this is a Failure.

    Definition Classes
    Try
  27. def isFailure: Boolean

    Returns true if the Try is a Failure, false otherwise.

    Returns true if the Try is a Failure, false otherwise.

    Definition Classes
    SuccessTry
  28. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
  29. def isLeft: Boolean

    Returns true if this is a Left, false otherwise.

    Returns true if this is a Left, false otherwise.

    Left("tulip").isLeft // true
    Right("venus fly-trap").isLeft // false
    Implicit information
    This member is added by an implicit conversion from Success[T] to Either[Throwable, T] performed by method try2either in scala.util.Try.
    Definition Classes
    Either
  30. def isRight: Boolean

    Returns true if this is a Right, false otherwise.

    Returns true if this is a Right, false otherwise.

    Left("tulip").isRight // false
    Right("venus fly-trap").isRight // true
    Implicit information
    This member is added by an implicit conversion from Success[T] to Either[Throwable, T] performed by method try2either in scala.util.Try.
    Definition Classes
    Either
  31. def isSuccess: Boolean

    Returns true if the Try is a Success, false otherwise.

    Returns true if the Try is a Success, false otherwise.

    Definition Classes
    SuccessTry
  32. def joinLeft[A1 >: A, B1 >: B, C](implicit ev: <:<[A1, Either[C, B1]]): Either[C, B1]

    Joins an Either through Left.

    Joins an Either through Left.

    This method requires that the left side of this Either is itself an Either type. That is, this must be some type like:

    Either[Either[C, B], B]

    (which respects the type parameter bounds, shown below.)

    If this instance is a Left[Either[C, B]] then the contained Either[C, B] will be returned, otherwise this value will be returned unmodified.

    Left[Either[Int, String], String](Right("flower")).joinLeft // Result: Right("flower")
    Left[Either[Int, String], String](Left(12)).joinLeft // Result: Left(12)
    Right[Either[Int, String], String]("daisy").joinLeft // Result: Right("daisy")

    This method, and joinRight, are analogous to Option#flatten

    Implicit information
    This member is added by an implicit conversion from Success[T] to Either[Throwable, T] performed by method try2either in scala.util.Try.
    Definition Classes
    Either
  33. def joinRight[A1 >: A, B1 >: B, C](implicit ev: <:<[B1, Either[A1, C]]): Either[A1, C]

    Joins an Either through Right.

    Joins an Either through Right.

    This method requires that the right side of this Either is itself an Either type. That is, this must be some type like:

    Either[A, Either[A, C]]

    (which respects the type parameter bounds, shown below.)

    If this instance is a Right[Either[A, C]] then the contained Either[A, C] will be returned, otherwise this value will be returned unmodified.

    Implicit information
    This member is added by an implicit conversion from Success[T] to Either[Throwable, T] performed by method try2either in scala.util.Try.
    Definition Classes
    Either
    Example:
    1. Right[String, Either[String, Int]](Right(12)).joinRight // Result: Right(12)
      Right[String, Either[String, Int]](Left("flower")).joinRight // Result: Left("flower")
      Left[String, Either[String, Int]]("flower").joinRight // Result: Left("flower")

      This method, and joinLeft, are analogous to Option#flatten

  34. def left: LeftProjection[Throwable, T]

    Projects this Either as a Left.

    Projects this Either as a Left.

    Implicit information
    This member is added by an implicit conversion from Success[T] to Either[Throwable, T] performed by method try2either in scala.util.Try.
    Definition Classes
    Either
  35. def map[U](f: (T) ⇒ U): Try[U]

    Maps the given function to the value from this Success or returns this if this is a Failure.

    Maps the given function to the value from this Success or returns this if this is a Failure.

    Definition Classes
    SuccessTry
  36. final def ne(arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  37. final def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  38. final def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  39. def orElse[U >: T](default: ⇒ Try[U]): Try[U]

    Returns this Try if it's a Success or the given default argument if this is a Failure.

    Returns this Try if it's a Success or the given default argument if this is a Failure.

    Definition Classes
    Try
  40. def recover[U >: T](rescueException: PartialFunction[Throwable, U]): Try[U]

    Applies the given function f if this is a Failure, otherwise returns this if this is a Success.

    Applies the given function f if this is a Failure, otherwise returns this if this is a Success. This is like map for the exception.

    Definition Classes
    SuccessTry
  41. def rescue[U >: T](f: PartialFunction[Throwable, Try[U]]): Try[U]

    Applies the given function f if this is a Failure, otherwise returns this if this is a Success.

    Applies the given function f if this is a Failure, otherwise returns this if this is a Success. This is like flatMap for the exception.

    Definition Classes
    SuccessTry
  42. def right: RightProjection[Throwable, T]

    Projects this Either as a Right.

    Projects this Either as a Right.

    Implicit information
    This member is added by an implicit conversion from Success[T] to Either[Throwable, T] performed by method try2either in scala.util.Try.
    Definition Classes
    Either
  43. def swap: Product with Serializable with Either[T, Throwable]

    If this is a Left, then return the left value in Right or vice versa.

    If this is a Left, then return the left value in Right or vice versa.

    Implicit information
    This member is added by an implicit conversion from Success[T] to Either[Throwable, T] performed by method try2either in scala.util.Try.
    Definition Classes
    Either
    Example:
    1. val l: Either[String, Int] = Left("left")
      val r: Either[Int, String] = l.swap // Result: Right("left")
  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  45. def toOption: Option[T]

    Returns None if this is a Failure or a Some containing the value if this is a Success.

    Returns None if this is a Failure or a Some containing the value if this is a Success.

    Definition Classes
    Try
  46. def toSeq: Seq[T]

    Returns an empty Seq (usually a List) if this is a Failure or a Seq containing the value if this is a Success.

    Returns an empty Seq (usually a List) if this is a Failure or a Seq containing the value if this is a Success.

    Definition Classes
    Try
  47. def transform[U](f: (Throwable) ⇒ Try[U], s: (T) ⇒ Try[U]): Try[U]

    Completes this Try by applying the function f to this if this is of type Failure, or conversely, by applying s if this is a Success.

    Completes this Try by applying the function f to this if this is of type Failure, or conversely, by applying s if this is a Success.

    Definition Classes
    Try
  48. val value: T

  49. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  52. def [B](y: B): (Success[T], B)

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

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Success[T] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (success: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Success[T] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (success: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Success[T]

    Implicit information
    This member is added by an implicit conversion from Success[T] to ArrowAssoc[Success[T]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (success: ArrowAssoc[Success[T]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Success[T]

    Implicit information
    This member is added by an implicit conversion from Success[T] to Ensuring[Success[T]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (success: Ensuring[Success[T]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Try[T]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion try2either from Success[T] to Either[Throwable, T]

Inherited by implicit conversion any2stringadd from Success[T] to StringAdd

Inherited by implicit conversion any2stringfmt from Success[T] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Success[T] to ArrowAssoc[Success[T]]

Inherited by implicit conversion any2Ensuring from Success[T] to Ensuring[Success[T]]