# LeftMatcher

### Related Doc: package matcher

#### case class LeftMatcher[T]() extends OptionLikeMatcher[[a]Either[a, _], T, T] with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, OptionLikeMatcher[[a]Either[a, _], T, T], Matcher[Either[T, Any]], AnyRef, Any
Ordering
1. Alphabetic
2. By inheritance
Inherited
1. LeftMatcher
2. Serializable
3. Serializable
4. Product
5. Equals
6. OptionLikeMatcher
7. Matcher
8. AnyRef
9. Any
1. Hide All
2. Show all
Visibility
1. Public
2. All

### Value Members

1. #### final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
2. #### final def ##(): Int

Definition Classes
AnyRef → Any
3. #### final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
4. #### def ^^[S](f: (S) ⇒ Expectable[Either[T, Any]], dummy: Int = 0): Matcher[S]

Adapt a matcher to another. ex: `be_==("message") ^^ (_.getMessage aka "trimmed") can be applied to an exception`

The dummy value is used to help to disambiguate with the overloaded ^^ function

Definition Classes
Matcher
5. #### def ^^[S](f: (S) ⇒ Either[T, Any]): Matcher[S]

Adapt a matcher to another. ex: ```be_==("message") ^^ (_.getMessage) can be applied to an exception ```

Definition Classes
Matcher
6. #### def and[S <: Either[T, Any]](m: ⇒ Matcher[S]): Matcher[S]

the logical and between 2 matchers

the logical and between 2 matchers

Definition Classes
Matcher

MatchResult.and

7. #### def apply[S <: Either[T, Any]](value: Expectable[S]): MatchResult[S]

apply this matcher to an Expectable

apply this matcher to an Expectable

returns

a MatchResult describing the outcome of the match

Definition Classes
OptionLikeMatcherMatcher
8. #### final def asInstanceOf[T0]: T0

Definition Classes
Any
9. #### def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
10. #### final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
11. #### def eventually(retries: Int, sleep: Duration): Matcher[Either[T, Any]]

returns

a matcher that needs to eventually match, after a given number of retries and a sleep time

Definition Classes
Matcher
12. #### def eventually: Matcher[Either[T, Any]]

returns

a matcher that needs to eventually match, after 40 retries and a sleep time of 100 milliseconds

Definition Classes
Matcher
13. #### def failure[S <: Either[T, Any]](message: ⇒ String, value: Expectable[S]): MatchResult[S]

This method can be used to create a failed match result

This method can be used to create a failed match result

Attributes
protected
Definition Classes
Matcher
14. #### def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
15. #### final def getClass(): Class[_]

Definition Classes
AnyRef → Any
16. #### def iff(b: Boolean): Matcher[Either[T, Any]]

when the condition is true the matcher is applied, when it's false, the matcher must fail

when the condition is true the matcher is applied, when it's false, the matcher must fail

Definition Classes
Matcher
17. #### final def isInstanceOf[T0]: Boolean

Definition Classes
Any
18. #### def lazily: Matcher[() ⇒ Either[T, Any]]

The `lazily` operator returns a Matcher which will match a function returning the expected value

The `lazily` operator returns a Matcher which will match a function returning the expected value

Definition Classes
Matcher
19. #### def like[R](f: PartialFunction[T, R])(implicit arg0: AsResult[R]): OptionLikeCheckedMatcher[[a]Either[a, _], T, T]

Definition Classes
OptionLikeMatcher
20. #### def mute: Matcher[Either[T, Any]]

returns

a Matcher with no messages

Definition Classes
Matcher
21. #### final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
22. #### def not: Matcher[Either[T, Any]]

negate a Matcher

negate a Matcher

Definition Classes
Matcher

MatchResult.not

23. #### final def notify(): Unit

Definition Classes
AnyRef
24. #### final def notifyAll(): Unit

Definition Classes
AnyRef
25. #### def or[S <: Either[T, Any]](m: ⇒ Matcher[S]): Matcher[S]

the logical or between 2 matchers

the logical or between 2 matchers

Definition Classes
Matcher

MatchResult.or

26. #### def orPending(message: (String) ⇒ String): Matcher[Either[T, Any]]

returns

a Pending MatchResult if this matcher fails, modifying the failure message with a pending message.

Definition Classes
Matcher
27. #### def orPending(m: String): Matcher[Either[T, Any]]

returns

a Pending MatchResult if this matcher fails, prefixing the failure message with a pending message. If the pending message is empty, only the failure message is printed

Definition Classes
Matcher
28. #### def orPending: Matcher[Either[T, Any]]

returns

a Pending MatchResult if this matcher fails

Definition Classes
Matcher
29. #### def orSkip(message: (String) ⇒ String): Matcher[Either[T, Any]]

returns

a Skip MatchResult if this matcher fails, modifying the failure message with a skip message.

Definition Classes
Matcher
30. #### def orSkip(m: String): Matcher[Either[T, Any]]

returns

a Skip MatchResult if this matcher fails, prefixing the failure message with a skip message. If the skip message is empty, only the failure message is printed

Definition Classes
Matcher
31. #### def orSkip: Matcher[Either[T, Any]]

returns

a Skip MatchResult if this matcher fails

Definition Classes
Matcher
32. #### def result[S <: Either[T, Any]](other: MatchResultMessages.MatchResultMessage, value: Expectable[S]): MatchResult[S]

returns

a MatchResult using the messages embedded in a MatchResultMessage (i.e. an accumulation of messages from other matches)

Attributes
protected
Definition Classes
Matcher
33. #### def result[S <: Either[T, Any]](other: Result, value: Expectable[S]): MatchResult[S]

returns

a Match Result from another result

Attributes
protected
Definition Classes
Matcher
34. #### def result[S <: Either[T, Any]](other: MatchResult[_], value: Expectable[S]): MatchResult[S]

returns

a MatchResult copied on another one, but with a different expectable

Attributes
protected
Definition Classes
Matcher
35. #### def result[S <: Either[T, Any]](test: ⇒ Boolean, okMessage: ⇒ String, koMessage: ⇒ String, value: Expectable[S], details: Details): MatchResult[S]

returns

a MatchResult with an okMessage, a koMessage, the expectable value and details about the failure if any

Attributes
protected
Definition Classes
Matcher
36. #### def result[S <: Either[T, Any]](test: ⇒ Boolean, okMessage: ⇒ String, koMessage: ⇒ String, value: Expectable[S], expected: String, actual: String): MatchResult[S]

returns

a MatchResult with an okMessage, a koMessage, the expectable value and the expected/actual values as string to display a failure comparison if necessary

Attributes
protected
Definition Classes
Matcher
37. #### def result[S <: Either[T, Any]](triplet: ⇒ (Boolean, String, String), value: Expectable[S]): MatchResult[S]

returns

a MatchResult with an okMessage, a koMessage and the expectable value

Attributes
protected
Definition Classes
Matcher
38. #### def result[S <: Either[T, Any]](test: ⇒ Boolean, okMessage: ⇒ String, koMessage: ⇒ String, value: Expectable[S]): MatchResult[S]

returns

a MatchResult with an okMessage, a koMessage and the expectable value

Attributes
protected
Definition Classes
Matcher
39. #### def setMessage(message: String): Matcher[Either[T, Any]]

returns

set a new failure message of a matcher

Definition Classes
Matcher
40. #### def success[S <: Either[T, Any]](message: ⇒ String, value: Expectable[S]): MatchResult[S]

This method can be used to create a successful match result

This method can be used to create a successful match result

Attributes
protected
Definition Classes
Matcher
41. #### final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
42. #### def test: (Either[T, Any]) ⇒ Boolean

returns

a test function corresponding to this matcher

Definition Classes
Matcher
43. #### def unless(b: Boolean, m: String = ""): Matcher[Either[T, Any]]

only apply this matcher if the condition is false

only apply this matcher if the condition is false

Definition Classes
Matcher
44. #### def updateMessage(f: (String) ⇒ String): Matcher[Either[T, Any]]

returns

update the failure message of a matcher

Definition Classes
Matcher
45. #### final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
48. #### def when(b: Boolean, m: String = ""): Matcher[Either[T, Any]]

only apply this matcher if the condition is true

only apply this matcher if the condition is true

Definition Classes
Matcher
49. #### def which[R](f: (T) ⇒ R)(implicit arg0: AsResult[R]): OptionLikeCheckedMatcher[[a]Either[a, _], T, T]

Definition Classes
OptionLikeMatcher