Class scala.util.Either.LeftProjection
final case class LeftProjection[+A, +B](e: Either[A, B]) extends Product with Serializable
Instance Constructors
new LeftProjection(e: Either[A, B])
Value Members
final def !=(arg0: Any): Boolean
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
. 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 LeftProjection[A, B] to any2stringadd[LeftProjection[A, B]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
def ->[B](y: B): (LeftProjection[A, B], B)
- Implicit
- This member is added by an implicit conversion from LeftProjection[A, B] to ArrowAssoc[LeftProjection[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)
.
- 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
.
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 typeT0
.
def clone(): AnyRef
Create a copy of the receiver object.
The default implementation of the clone
method is platform dependent.
- returns
a copy of the receiver object.
val e: Either[A, B]
def ensuring(cond: (LeftProjection[A, B]) ⇒ Boolean, msg: ⇒ Any): LeftProjection[A, B]
- Implicit
- This member is added by an implicit conversion from LeftProjection[A, B] to Ensuring[LeftProjection[A, B]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: (LeftProjection[A, B]) ⇒ Boolean): LeftProjection[A, B]
- Implicit
- This member is added by an implicit conversion from LeftProjection[A, B] to Ensuring[LeftProjection[A, B]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): LeftProjection[A, B]
- Implicit
- This member is added by an implicit conversion from LeftProjection[A, B] to Ensuring[LeftProjection[A, B]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean): LeftProjection[A, B]
- Implicit
- This member is added by an implicit conversion from LeftProjection[A, B] to Ensuring[LeftProjection[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
).
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 exists(p: (A) ⇒ Boolean): Boolean
Returns false
if Right
or returns the result of the application of the given function to the Left
value.
Left(12).left.exists(_ > 10) // true Left(7).left.exists(_ > 10) // false Right(12).left.exists(_ > 10) // false
def filter[B1](p: (A) ⇒ Boolean): Option[Either[A, B1]]
Returns None
if this is a Right
or if the given predicate p
does not hold for the left value, otherwise, returns a Left
.
Left(12).left.filter(_ > 10) // Some(Left(12)) Left(7).left.filter(_ > 10) // None Right(12).left.filter(_ > 10) // None
def finalize(): Unit
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( classOf[java.lang.Throwable] )
- Note
not specified by SLS as a member of AnyRef
def flatMap[A1, B1 >: B](f: (A) ⇒ Either[A1, B1]): Either[A1, B1]
Binds the given function across Left
.
Left(12).left.flatMap(x => Left("scala")) // Left("scala") Right(12).left.flatMap(x => Left("scala")) // Right(12)
- f
The function to bind across
Left
.
def forall(p: (A) ⇒ Boolean): Boolean
Returns true
if Right
or returns the result of the application of the given function to the Left
value.
Left(12).left.forall(_ > 10) // true Left(7).left.forall(_ > 10) // false Right(12).left.forall(_ > 10) // true
def foreach[U](f: (A) ⇒ U): Unit
Executes the given side-effecting function if this is a Left
.
Left(12).left.foreach(x => println(x)) // prints "12" Right(12).left.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. Format strings are as for String.format
(@see java.lang.String.format).
- Implicit
- This member is added by an implicit conversion from LeftProjection[A, B] to StringFormat[LeftProjection[A, B]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
def get: A
Returns the value from this Left
or throws java.util.NoSuchElementException
if this is a Right
.
Left(12).left.get // 12 Right(12).left.get // NoSuchElementException
- Exceptions thrown
java.util.NoSuchElementException
if the projection is scala.util.Right
final def getClass(): Class[_]
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
def getOrElse[A1 >: A](or: ⇒ A1): A1
Returns the value from this Left
or the given argument if this is a Right
.
Left(12).left.getOrElse(17) // 12 Right(12).left.getOrElse(17) // 17
final def isInstanceOf[T0]: Boolean
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 typeT0
;false
otherwise.
- Definition Classes
- Any
def map[A1](f: (A) ⇒ A1): Either[A1, B]
Maps the function argument through Left
.
Left(12).left.map(_ + 2) // Left(14) Right[Int, Int](12).left.map(_ + 2) // Right(12)
final def ne(arg0: AnyRef): Boolean
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.
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
def toOption: Option[A]
Returns a Some
containing the Left
value if it exists or a None
if this is a Right
.
Left(12).left.toOption // Some(12) Right(12).left.toOption // None
def toSeq: Seq[A]
Returns a Seq
containing the Left
value if it exists or an empty Seq
if this is a Right
.
Left(12).left.toSeq // Seq(12) Right(12).left.toSeq // Seq()
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
def →[B](y: B): (LeftProjection[A, B], B)
- Implicit
- This member is added by an implicit conversion from LeftProjection[A, B] to ArrowAssoc[LeftProjection[A, B]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/util/Either$$LeftProjection.html
Projects an
Either
into aLeft
.scala.util.Either#left