Either

Companion object Either

sealed abstract class Either[+A, +B] extends Product with Serializable

Represents a value of one of two possible types (a disjoint union.) An instance of Either is either an instance of scala.util.Left or scala.util.Right.

A common use of Either is as an alternative to scala.Option for dealing with possible missing values. In this usage, scala.None is replaced with a scala.util.Left which can contain useful information. scala.util.Right takes the place of scala.Some. Convention dictates that Left is used for failure and Right is used for success.

For example, you could use Either[String, Int] to detect whether a received input is a String or an Int.

val in = Console.readLine("Type Either a string or an Int: ")
val result: Either[String,Int] = try {
    Right(in.toInt)
  } catch {
    case e: Exception =>
      Left(in)
}

println(result match {
  case Right(x) => s"You passed me the Int: $x, which I will increment. $x + 1 = ${x+1}"
  case Left(x)  => s"You passed me the String: $x"
})

Either is right-biased, which means that Right is assumed to be the default case to operate on. If it is Left, operations like map, flatMap, ... return the Left value unchanged:

Right(12).map(_ * 2) // Right(24)
Left(23).map(_ * 2)  // Left(23)

As Either defines the methods map and flatMap, it can also be used in for comprehensions:

val right1: Right[Double, Int] = Right(1)
val right2                     = Right(2)
val right3                     = Right(3)
val left23: Left[Double, Int]  = Left(23.0)
val left42                     = Left(42.0)

for (
  a <- right1;
  b <- right2;
  c <- right3
) yield a + b + c // Right(6)

for (
  a <- right1;
  b <- right2;
  c <- left23
) yield a + b + c // Left(23.0)

for (
  a <- right1;
  b <- left23;
  c <- right2
) yield a + b + c // Left(23.0)

// It is advisable to provide the type of the “missing” value (especially the right value for `Left`)
// as otherwise that type might be infered as `Nothing` without context:
for (
  a <- left23;
  b <- right1;
  c <- left42  // type at this position: Either[Double, Nothing]
) yield a + b + c
//            ^
// error: ambiguous reference to overloaded definition,
// both method + in class Int of type (x: Char)Int
// and  method + in class Int of type (x: Byte)Int
// match argument types (Nothing)

Source: Either.scala
Version: 2.0, 2016-07-15
Since: 2.7

Linear Supertypes

Serializable, java.io.Serializable, Product, Equals, AnyRef, Any

Known Subclasses

Left, Right

Type Hierarchy

Ordering

Alphabetic
By Inheritance

Inherited

Either
Serializable
Serializable
Product
Equals
AnyRef
Any

Implicitly

by MergeableEither
by any2stringadd
by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract def canEqual(that: Any): Boolean
A method that should be called from every well-designed equals method that is open to be overridden in a subclass.
A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.
that
the value being probed for possible equality
returns
true if this instance can possibly equal that, otherwise false

Definition Classes
Equals
abstract 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
```
abstract 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
```
abstract def productArity: Int
The size of this product.
The size of this product.
returns
for a product A(x₁, ..., x_k), returns k

Definition Classes
Product
abstract def productElement(n: Int): Any
The n^th element of this product, 0-based.
The n^th element of this product, 0-based. In other words, for a product A(x₁, ..., x_k), returns x_(n+1) where 0 <= n < k.
n
the index of the element to return
returns
the element n elements after the first element

Definition Classes
Product
Exceptions thrown

Concrete Value Members

final def !=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
returns
true if !(this == that), false otherwise.

Definition Classes
AnyRef → Any
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
def +(other: String): String

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

Implicit
This member is added by an implicit conversion from Either[A, B] to ArrowAssoc[Either[A, B]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
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
AnyRef → Any
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.
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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
Note
not specified by SLS as a member of AnyRef
final def contains[BB >: B](elem: BB): Boolean
Returns true if this is a Right and its value is equal to elem (as determined by ==), returns false otherwise.
Returns true if this is a Right and its value is equal to elem (as determined by ==), returns false otherwise.
```
// Returns true because value of Right is "something" which equals "something".
Right("something") contains "something"

// Returns false because value of Right is "something" which does not equal "anything".
Right("something") contains "anything"

// Returns false because there is no value for Right.
Left("something") contains "something"
```
elem
the element to test.
returns
true if the option has an element that is equal (as determined by ==) to elem, false otherwise.
def ensuring(cond: (Either[A, B]) ⇒ Boolean, msg: ⇒ Any): Either[A, B]

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

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

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

Implicit
This member is added by an implicit conversion from Either[A, B] to Ensuring[Either[A, B]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean
Tests whether the argument (that) is a reference to the receiver object (this).
Tests whether the argument (that) 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
def equals(arg0: Any): Boolean
The equality method for reference types.
The equality method for reference types. Default implementation delegates to eq.
See also equals in scala.Any.
returns
true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
AnyRef → Any
def exists(p: (B) ⇒ Boolean): Boolean
Returns false if Left or returns the result of the application of the given function to the Right value.
Returns false if Left or returns the result of the application of the given function to the Right value.
```
Right(12).exists(_ > 10) // true
Right(7).exists(_ > 10)  // false
Left(12).exists(_ > 10)  // false
```
def filterOrElse[AA >: A](p: (B) ⇒ Boolean, zero: ⇒ AA): Either[AA, B]
Returns Right with the existing value of Right if this is a Right and the given predicate p holds for the right value, returns Left(zero) if this is a Right and the given predicate p does not hold for the right value, returns Left with the existing value of Left if this is a Left.
Returns Right with the existing value of Right if this is a Right and the given predicate p holds for the right value, returns Left(zero) if this is a Right and the given predicate p does not hold for the right value, returns Left with the existing value of Left if this is a Left.
```
Right(12).filterOrElse(_ > 10, -1) // Right(12)
Right(7).filterOrElse(_ > 10, -1)  // Left(-1)
Left(12).filterOrElse(_ > 10, -1)  // Left(12)
```
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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
Note
not specified by SLS as a member of AnyRef
def flatMap[AA >: A, Y](f: (B) ⇒ Either[AA, Y]): Either[AA, Y]
Binds the given function across Right.
Binds the given function across Right.
f
The function to bind across Right.
def fold[C](fa: (A) ⇒ C, fb: (B) ⇒ C): C
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
Example:
1. val result: Either[Exception, Value] = possiblyFailingOperation() log(result.fold( ex => s"Operation failed with $ex", v => s"Operation produced value: $v" ))
def forall(f: (B) ⇒ Boolean): Boolean
Returns true if Left or returns the result of the application of the given function to the Right value.
Returns true if Left or returns the result of the application of the given function to the Right value.
```
Right(12).forall(_ > 10) // true
Right(7).forall(_ > 10)  // false
Left(12).forall(_ > 10)  // true
```
def foreach[U](f: (B) ⇒ U): Unit
Executes the given side-effecting function if this is a Right.
Executes the given side-effecting function if this is a Right.
```
Right(12).foreach(x => println(x)) // prints "12"
Left(12).foreach(x => println(x))  // doesn't print
```
f
The side-effecting function to execute.
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
This member is added by an implicit conversion from Either[A, B] to StringFormat[Either[A, B]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]
Returns the runtime class representation of the object.
Returns the runtime class representation of the object.
returns
a class object corresponding to the runtime type of the receiver.

Definition Classes
AnyRef → Any
def getOrElse[BB >: B](or: ⇒ BB): BB
Returns the value from this Right or the given argument if this is a Left.
Returns the value from this Right or the given argument if this is a Left.
```
Right(12).getOrElse(17) // 12
Left(12).getOrElse(17)  // 17
```
def hashCode(): Int
The hashCode method for reference types.
The hashCode method for reference types. See hashCode in scala.Any.
returns
the hash code value for this object.

Definition Classes
AnyRef → Any
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
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
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.
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
def map[Y](f: (B) ⇒ Y): Either[A, Y]
The given function is applied if this is a Right.
The given function is applied if this is a Right.
```
Right(12).map(x => "flower") // Result: Right("flower")
Left(12).map(x => "flower")  // Result: Left(12)
```
def merge: B

Implicit
This member is added by an implicit conversion from Either[A, B] to MergeableEither[B] performed by method MergeableEither in scala.util.Either.
Definition Classes
MergeableEither
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
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
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
def productIterator: Iterator[Any]
An iterator over all the elements of this product.
An iterator over all the elements of this product.
returns
in the default implementation, an Iterator[Any]

Definition Classes
Product
def productPrefix: String
A string used in the toString methods of derived classes.
A string used in the toString methods of derived classes. Implementations may override this method to prepend a string prefix to the result of toString methods.
returns
in the default implementation, the empty string

Definition Classes
Product

def swap: Either[B, A]

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

Examples:

val right = Right(2)
val left  = Left(3)
for (
  r1 <- right;
  r2 <- left.swap
) yield r1 * r2 // Right(6)

val left: Either[String, Int] = Left("left")
val right: Either[Int, String] = l.swap // Result: Right("left")

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

Definition Classes
AnyRef
def toOption: Option[B]
Returns a Some containing the Right value if it exists or a None if this is a Left.
Returns a Some containing the Right value if it exists or a None if this is a Left.
```
Right(12).toOption // Some(12)
Left(12).toOption  // None
```
def toSeq: collection.immutable.Seq[B]
Returns a Seq containing the Right value if it exists or an empty Seq if this is a Left.
Returns a Seq containing the Right value if it exists or an empty Seq if this is a Left.
```
Right(12).toSeq // Seq(12)
Left(12).toSeq  // Seq()
```
def toString(): String
Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
returns
a String representation of the object.

Definition Classes
AnyRef → Any
def toTry(implicit ev: <:<[A, Throwable]): Try[B]
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (Either[A, B], B)

Implicit
This member is added by an implicit conversion from Either[A, B] to ArrowAssoc[Either[A, B]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Deprecated Value Members

def left: LeftProjection[A, B]
Projects this Either as a Left.
Projects this Either as a Left.

Annotations
@deprecated
Deprecated
(Since version 2.12.0) use swap instead
def right: RightProjection[A, B]
Projects this Either as a Right.
Projects this Either as a Right.

Annotations
@deprecated
Deprecated
(Since version 2.12.0) Either is now right-biased

Packages

Package structure

Automatic imports

Either

Companion object Either

sealed abstract class Either[+A, +B] extends Product with Serializable

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion MergeableEither from Either[A, B] to MergeableEither[B]

Inherited by implicit conversion any2stringadd from Either[A, B] to any2stringadd[Either[A, B]]

Inherited by implicit conversion StringFormat from Either[A, B] to StringFormat[Either[A, B]]

Inherited by implicit conversion Ensuring from Either[A, B] to Ensuring[Either[A, B]]

Inherited by implicit conversion ArrowAssoc from Either[A, B] to ArrowAssoc[Either[A, B]]

Ungrouped

Packages

Package structure

Automatic imports

Either 

Companion object Either

sealed abstract class Either[+A, +B] extends Product with Serializable

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion MergeableEither from Either[A, B] to MergeableEither[B]

Inherited by implicit conversion any2stringadd from Either[A, B] to any2stringadd[Either[A, B]]

Inherited by implicit conversion StringFormat from Either[A, B] to StringFormat[Either[A, B]]

Inherited by implicit conversion Ensuring from Either[A, B] to Ensuring[Either[A, B]]

Inherited by implicit conversion ArrowAssoc from Either[A, B] to ArrowAssoc[Either[A, B]]

Ungrouped

Either