Packages

final case class -\/[A, B](a: A) extends \/[A, B] with Product with Serializable

A left disjunction

Often used to represent the failure case of a result

Source
Either.scala
Linear Supertypes
\/[A, B], Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. -\/
  2. \/
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new -\/(a: A)

Type Members

  1. final class SwitchingDisjunction[X] extends AnyRef
    Definition Classes
    \/

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +++(x: ⇒ \/[A, B])(implicit M1: Semigroup[B], M2: Semigroup[A]): \/[A, B]

    Sums up values inside disjunction, if both are left or right.

    Sums up values inside disjunction, if both are left or right. Returns first left otherwise.

    \/-(v1) +++ \/-(v2) → \/-(v1 + v2)
\/-(v1) +++ -\/(v2) → -\/(v2)
-\/(v1) +++ \/-(v2) → -\/(v1)
-\/(v1) +++ -\/(v2) → -\/(v1 + v2)
    Definition Classes
    \/
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def ===[AA >: A, BB >: B](x: \/[AA, BB])(implicit EA: Equal[AA], EB: Equal[BB]): Boolean

    Compare two disjunction values for equality.

    Compare two disjunction values for equality.

    Definition Classes
    \/
  6. def @\?/[AA, BB](k: (Validation[A, B]) ⇒ Validation[AA, BB]): \/[AA, BB]

    Run a validation function and back to disjunction again.

    Run a validation function and back to disjunction again. Alias for validationed

    Definition Classes
    \/
  7. val a: A
  8. def ap[C](f: ⇒ \/[A, (B) ⇒ C]): \/[A, C]

    Apply a function in the environment of the right of this disjunction.

    Apply a function in the environment of the right of this disjunction.

    Definition Classes
    \/
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def bimap[C, D](f: (A) ⇒ C, g: (B) ⇒ D): \/[C, D]

    Binary functor map on this disjunction.

    Binary functor map on this disjunction.

    Definition Classes
    \/
  11. def bitraverse[F[_], C, D](f: (A) ⇒ F[C], g: (B) ⇒ F[D])(implicit arg0: Functor[F]): F[\/[C, D]]

    Binary functor traverse on this disjunction.

    Binary functor traverse on this disjunction.

    Definition Classes
    \/
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  13. def coerceRight[C]: \/[A, C]
  14. def compare[AA >: A, BB >: B](x: \/[AA, BB])(implicit EA: Order[AA], EB: Order[BB]): Ordering

    Compare two disjunction values for ordering.

    Compare two disjunction values for ordering.

    Definition Classes
    \/
  15. def ensure(onLeft: ⇒ A)(f: (B) ⇒ Boolean): \/[A, B]

    Ensures that the right value of this disjunction satisfies the given predicate, or returns left with the given value.

    Ensures that the right value of this disjunction satisfies the given predicate, or returns left with the given value.

    Definition Classes
    \/
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def exists[BB >: B](p: (BB) ⇒ Boolean): Boolean

    Return true if this disjunction is a right value satisfying the given predicate.

    Return true if this disjunction is a right value satisfying the given predicate.

    Definition Classes
    \/
  18. def filter(p: (B) ⇒ Boolean)(implicit M: Monoid[A]): \/[A, B]

    Filter on the right of this disjunction.

    Filter on the right of this disjunction.

    Definition Classes
    \/
  19. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def flatMap[D](g: (B) ⇒ \/[A, D]): \/[A, D]

    Bind through the right of this disjunction.

    Bind through the right of this disjunction.

    Definition Classes
    \/
  21. def fold[X](l: (A) ⇒ X, r: (B) ⇒ X): X

    Catamorphism.

    Catamorphism. Run the first given function if left, otherwise, the second given function.

    Definition Classes
    \/
  22. def foldConst[X](l: ⇒ X, r: ⇒ X): X

    Evaluate l and return if left, otherwise, r.

    Evaluate l and return if left, otherwise, r.

    Definition Classes
    \/
  23. def foldRight[Z](z: ⇒ Z)(f: (B, ⇒ Z) ⇒ Z): Z

    Fold on the right of this disjunction.

    Fold on the right of this disjunction.

    Definition Classes
    \/
  24. def forall[BB >: B](p: (BB) ⇒ Boolean): Boolean

    Return true if this disjunction is a left value or the right value satisfies the given predicate.

    Return true if this disjunction is a left value or the right value satisfies the given predicate.

    Definition Classes
    \/
  25. def foreach(g: (B) ⇒ Unit): Unit

    Run the side-effect on the right of this disjunction.

    Run the side-effect on the right of this disjunction.

    Definition Classes
    \/
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def getOrElse[BB >: B](x: ⇒ BB): BB

    Return the right value of this disjunction or the given default if left.

    Return the right value of this disjunction or the given default if left. Alias for |

    Definition Classes
    \/
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def isLeft: Boolean

    Return true if this disjunction is left.

    Return true if this disjunction is left.

    Definition Classes
    \/
  30. def isRight: Boolean

    Return true if this disjunction is right.

    Return true if this disjunction is right.

    Definition Classes
    \/
  31. def leftMap[C](f: (A) ⇒ C): \/[C, B]

    Run the given function on the left value.

    Run the given function on the left value.

    Definition Classes
    \/
  32. def loopl[X](left: (A) ⇒ \/[X, \/[A, B]], right: (B) ⇒ X): X

    Spin in tail-position on the left value of this disjunction.

    Spin in tail-position on the left value of this disjunction.

    Definition Classes
    \/
  33. def loopr[X](left: (A) ⇒ X, right: (B) ⇒ \/[X, \/[A, B]]): X

    Spin in tail-position on the right value of this disjunction.

    Spin in tail-position on the right value of this disjunction.

    Definition Classes
    \/
  34. def map[D](g: (B) ⇒ D): \/[A, D]

    Map on the right of this disjunction.

    Map on the right of this disjunction.

    Definition Classes
    \/
  35. def merge[AA >: A](implicit ev: <~<[B, AA]): AA

    Return the value from whichever side of the disjunction is defined, given a commonly assignable type.

    Return the value from whichever side of the disjunction is defined, given a commonly assignable type.

    Definition Classes
    \/
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. def orElse[C](x: ⇒ \/[C, B]): \/[C, B]

    Return this if it is a right, otherwise, return the given value.

    Return this if it is a right, otherwise, return the given value. Alias for |||

    Definition Classes
    \/
  40. def orRaiseError[F[_]](implicit F: MonadError[F, A]): F[B]
    Definition Classes
    \/
  41. def recover(pf: PartialFunction[A, B]): \/[A, B]

    Run the given function on the left and return right with the result.

    Run the given function on the left and return right with the result.

    Definition Classes
    \/
  42. def recoverWith(pf: PartialFunction[A, \/[A, B]]): \/[A, B]

    Run the given function on the left and return the result.

    Run the given function on the left and return the result.

    Definition Classes
    \/
  43. def show[AA >: A, BB >: B](implicit SA: Show[AA], SB: Show[BB]): Cord

    Show for a disjunction value.

    Show for a disjunction value.

    Definition Classes
    \/
  44. def swap: \/[B, A]

    Flip the left/right values in this disjunction.

    Flip the left/right values in this disjunction. Alias for unary_~

    Definition Classes
    \/
  45. def swapped[AA, BB](k: (\/[B, A]) ⇒ \/[BB, AA]): \/[AA, BB]

    Run the given function on this swapped value.

    Run the given function on this swapped value. Alias for ~

    Definition Classes
    \/
  46. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  47. def toEither: Either[A, B]

    Convert to a core scala.Either at your own peril.

    Convert to a core scala.Either at your own peril.

    Definition Classes
    \/
  48. def toIList[BB >: B]: IList[BB]

    Return an empty list or list with one element on the right of this disjunction.

    Return an empty list or list with one element on the right of this disjunction.

    Definition Classes
    \/
  49. def toList: List[B]

    Return an empty list or list with one element on the right of this disjunction.

    Return an empty list or list with one element on the right of this disjunction.

    Definition Classes
    \/
  50. def toMaybe[BB >: B]: Maybe[BB]

    Return an empty maybe or option with one element on the right of this disjunction.

    Return an empty maybe or option with one element on the right of this disjunction. Useful to sweep errors under the carpet.

    Definition Classes
    \/
  51. def toOption: Option[B]

    Return an empty option or option with one element on the right of this disjunction.

    Return an empty option or option with one element on the right of this disjunction. Useful to sweep errors under the carpet.

    Definition Classes
    \/
  52. def toStream: Stream[B]

    Return an empty stream or stream with one element on the right of this disjunction.

    Return an empty stream or stream with one element on the right of this disjunction.

    Definition Classes
    \/
  53. def toThese: \&/[A, B]

    Convert to a These.

    Convert to a These.

    Definition Classes
    \/
  54. def traverse[F[_], D](g: (B) ⇒ F[D])(implicit arg0: Applicative[F]): F[\/[A, D]]

    Traverse on the right of this disjunction.

    Traverse on the right of this disjunction.

    Definition Classes
    \/
  55. def unary_~: \/[B, A]

    Flip the left/right values in this disjunction.

    Flip the left/right values in this disjunction. Alias for swap

    Definition Classes
    \/
  56. def validation: Validation[A, B]

    Convert to a Validation.

    Convert to a Validation.

    Definition Classes
    \/
  57. def validationNel[AA >: A]: ValidationNel[AA, B]

    Convert to a ValidationNel.

    Convert to a ValidationNel.

    Definition Classes
    \/
  58. def validationed[AA, BB](k: (Validation[A, B]) ⇒ Validation[AA, BB]): \/[AA, BB]

    Run a validation function and back to disjunction again.

    Run a validation function and back to disjunction again. Alias for @\?/

    Definition Classes
    \/
  59. def valueOr[BB >: B](x: (A) ⇒ BB): BB

    Return the right value of this disjunction or run the given function on the left.

    Return the right value of this disjunction or run the given function on the left.

    Definition Classes
    \/
  60. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  63. def |[BB >: B](x: ⇒ BB): BB

    Return the right value of this disjunction or the given default if left.

    Return the right value of this disjunction or the given default if left. Alias for getOrElse

    Definition Classes
    \/
  64. def |||[C](x: ⇒ \/[C, B]): \/[C, B]

    Return this if it is a right, otherwise, return the given value.

    Return this if it is a right, otherwise, return the given value. Alias for orElse

    Definition Classes
    \/
  65. def ~[AA, BB](k: (\/[B, A]) ⇒ \/[BB, AA]): \/[AA, BB]

    Run the given function on this swapped value.

    Run the given function on this swapped value. Alias for swapped

    Definition Classes
    \/

Deprecated Value Members

  1. def :?>>[X](right: ⇒ X): SwitchingDisjunction[X]

    If this disjunction is right, return the given X value, otherwise, return the X value given to the return value.

    If this disjunction is right, return the given X value, otherwise, return the X value given to the return value.

    Definition Classes
    \/
    Annotations
    @deprecated
    Deprecated

    (Since version 7.3.0) Due to SI-1980, <<?: will always evaluate its left argument; use foldConst instead

Inherited from \/[A, B]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped