scala.util.Either

# RightProjection

#### final case class RightProjection[+A, +B](e: Either[A, B]) extends Product with Serializable

Projects an `Either` into a `Right`.

This allows for-comprehensions over Either instances - for example

    for (s <- Right("flower").right) yield s.length // Right(6)

Continuing the analogy with scala.Option, a `RightProjection` declares that `Right` should be analogous to `Some` in some code.

Analogous to `LeftProjection`, see example usage in its documentation above.

Source
  Either.scala
Version

  1.0, 11/10/2008

Linear Supertypes
Serializable, java.io.Serializable, Product, Equals, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. RightProjection
2. Serializable
3. Serializable
4. Product
5. Equals
6. AnyRef
7. Any

Implicitly

1. by any2stringadd
2. by any2stringfmt
3. by any2ArrowAssoc
4. by any2Ensuring

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Instance Constructors

1. #### new RightProjection(e: Either[A, B])

### 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 RightProjection[A, B] to StringAdd performed by method any2stringadd in scala.Predef.
   Definition Classes
     StringAdd

5. #### def ->[B](y: B): (RightProjection[A, B], B)

   Implicit information
     This member is added by an implicit conversion from RightProjection[A, B] to ArrowAssoc[RightProjection[A, B]] 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. #### 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`.

9. #### 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

10. #### val e: Either[A, B]

11. #### def ensuring(cond: (RightProjection[A, B]) ⇒ Boolean, msg: ⇒ Any): RightProjection[A, B]

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

12. #### def ensuring(cond: (RightProjection[A, B]) ⇒ Boolean): RightProjection[A, B]

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

13. #### def ensuring(cond: Boolean, msg: ⇒ Any): RightProjection[A, B]

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

14. #### def ensuring(cond: Boolean): RightProjection[A, B]

    Implicit information
      This member is added by an implicit conversion from RightProjection[A, B] to Ensuring[RightProjection[A, B]] 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 exists(f: (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).right.exists(_ > 10)  // true
        Right(7).right.exists(_ > 10)   // false
        Left(12).right.exists(_ > 10)   // false

17. #### def filter[X](p: (B) ⇒ Boolean): Option[Either[X, B]]

    Returns `None` if this is a `Left` or if the given predicate `p` does not hold for the right value, otherwise, returns a `Right`.

    Returns `None` if this is a `Left` or if the given predicate `p` does not hold for the right value, otherwise, returns a `Right`.

        Right(12).right.filter(_ > 10) // Some(Right(12))
        Right(7).right.filter(_ > 10)  // None
        Left(12).right.filter(_ > 10)  // None

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[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws()
    Note

      not specified by SLS as a member of AnyRef

19. #### 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`.

20. #### 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).right.forall(_ > 10) // true
        Right(7).right.forall(_ > 10)  // false
        Left(12).right.forall(_ > 10)  // true

21. #### def foreach[U](f: (B) ⇒ U): Any

    Executes the given side-effecting function if this is a `Right`.

    Executes the given side-effecting function if this is a `Right`.

        Right(12).right.foreach(x => println(x)) // prints "12"
        Left(12).right.foreach(x => println(x))  // doesn't print

    f

      The side-effecting function to execute.

22. #### 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 RightProjection[A, B] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()

23. #### def get: B

    Returns the value from this `Right` or throws `Predef.NoSuchElementException` if this is a `Left`.

    Returns the value from this `Right` or throws `Predef.NoSuchElementException` if this is a `Left`.

        Right(12).right.get // 12
        Left(12).right.get // NoSuchElementException

    Exceptions thrown
      Predef.NoSuchElementException

      if the projection is `Left`.

24. #### 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

25. #### 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).right.getOrElse(17) // 12
        Left(12).right.getOrElse(17)  // 17

26. #### 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

27. #### def map[Y](f: (B) ⇒ Y): Product with Serializable with 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).right.map(x => "flower") // Result: Right("flower")
        Left(12).right.map(x => "flower")  // Result: Left(12)

28. #### 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

29. #### 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

30. #### 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

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

    Definition Classes
      AnyRef

32. #### 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).right.toOption // Some(12)
        Left(12).right.toOption // None

33. #### def toSeq: collection.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).right.toSeq // Seq(12)
        Left(12).right.toSeq // Seq()

34. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

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

    Definition Classes
      AnyRef
    Annotations
      @throws()

36. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

37. #### def →[B](y: B): (RightProjection[A, B], B)

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

         (rightProjection: StringAdd).self

   Definition Classes
     StringAdd

2. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from RightProjection[A, B] 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:

         (rightProjection: StringFormat).self

   Definition Classes
     StringFormat

### Deprecated Value Members

1. #### def x: RightProjection[A, B]

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

         (rightProjection: ArrowAssoc[RightProjection[A, B]]).x

   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `leftOfArrow`instead``

2. #### def x: RightProjection[A, B]

   Implicit information
     This member is added by an implicit conversion from RightProjection[A, B] to Ensuring[RightProjection[A, B]] 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:

         (rightProjection: Ensuring[RightProjection[A, B]]).x

   Definition Classes
     Ensuring
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `resultOfEnsuring`instead``

### Inherited from Serializable

### Inherited from java.io.Serializable

### Inherited from Product

### Inherited from Equals

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from RightProjection[A, B] to StringAdd

### Inherited by implicit conversion any2stringfmt from RightProjection[A, B] to StringFormat

### Inherited by implicit conversion any2ArrowAssoc from RightProjection[A, B] to ArrowAssoc[RightProjection[A, B]]

### Inherited by implicit conversion any2Ensuring from RightProjection[A, B] to Ensuring[RightProjection[A, B]]

### Ungrouped