ShouldThrownMatchers

Companion
class
trait StandardResults
trait Matchers
trait EventuallyResults
trait NumberOfTimes
trait ImplicitParameters
trait TraversableBaseMatchersLowImplicits
class Object
trait Matchable
class Any

Type members

Inherited classlikes

class ExceptionClassMatcher(klass: Class[_])

Exception matcher checking the type of a thrown exception.

Exception matcher checking the type of a thrown exception.

Inherited from
ExceptionMatchers
class ExceptionMatcher[E <: Throwable](exception: E)

This matchers matches exception instances.

This matchers matches exception instances.

See also

throwA

Inherited from
ExceptionMatchers
class FindMatcher(t: => String)

Matcher to find if the regexp a is found inside b. This matcher can be specialized to a FindMatcherWithGroups which will also check the found groups

Matcher to find if the regexp a is found inside b. This matcher can be specialized to a FindMatcherWithGroups which will also check the found groups

Inherited from
StringMatchers
class FindMatcherPattern(p: Pattern)

Matcher to find if the pattern p is found inside b.

Matcher to find if the pattern p is found inside b.

Inherited from
StringMatchers
class FindMatcherPatternWithGroups(p: Pattern, groups: String*)

Matcher to find if the pattern p is found inside b.

Matcher to find if the pattern p is found inside b.

Inherited from
StringMatchers
class FindMatcherRegex(r: Regex)

Matcher to find if the Regex r is found inside b.

Matcher to find if the Regex r is found inside b.

Inherited from
StringMatchers
class FindMatcherWithGroups(t: => String, groups: String*)

Matcher to find if the regexp a is found inside b. This matcher checks if the found groups are really the ones expected

Matcher to find if the regexp a is found inside b. This matcher checks if the found groups are really the ones expected

Inherited from
StringMatchers
Inherited from
ImplicitParameters
class expectShould[T](tm: => T)(using not: NotGiven[NoShouldExpectations])
Inherited from
ShouldExpectations
class expectedShould[T](tm: Expectable[T])(using not: NotGiven[NoShouldExpectations])
Inherited from
ShouldExpectations

Value members

Inherited methods

def !=/(s: String): Matcher[String]

matches if a.toLowerCase.trim != b.toLowerCase.trim

matches if a.toLowerCase.trim != b.toLowerCase.trim

Inherited from
StringMatchers
def !==[T](t: => T)(using `evidence$4`: Diffable[T]): Matcher[T]

matches if a != b

matches if a != b

Inherited from
AnyMatchers
def <[S](n: S)(using `evidence$19`: Ordering[S]): BeLessThan[S]

alias for beLessThan

alias for beLessThan

Inherited from
NumericMatchers
def <=[S](n: S)(using `evidence$15`: Ordering[S]): BeLessThanOrEqualTo[S]

alias for beLessThanOrEqualTo

alias for beLessThanOrEqualTo

Inherited from
NumericMatchers
def ==/(s: String): Matcher[String]

matches if a.toLowerCase.trim = b.toLowerCase.trim

matches if a.toLowerCase.trim = b.toLowerCase.trim

Inherited from
StringMatchers
def ===[T](t: => T)(using `evidence$3`: Diffable[T]): EqualityMatcher[T]

matches if a == b

matches if a == b

Inherited from
AnyMatchers
def ==~[T, S](s: => S)(using `evidence$8`: Diffable[T], convert: Conversion[S, T]): Matcher[T]

matches if a == b after an implicit conversion

matches if a == b after an implicit conversion

Inherited from
AnyMatchers
def =~[T](t: T)(using `evidence$5`: MatchingExpression[T]): Matcher[String]

alias for beMatching but matching just a fragment of the string

alias for beMatching but matching just a fragment of the string

Inherited from
StringMatchers
def >[S](n: S)(using `evidence$27`: Ordering[S]): BeGreaterThan[S]

alias for beGreaterThan

alias for beGreaterThan

Inherited from
NumericMatchers
def >=[S](n: S)(using `evidence$23`: Ordering[S]): Matcher[S]

alias for beGreaterThanOrEqualTo

alias for beGreaterThanOrEqualTo

Inherited from
NumericMatchers
def aFailedTry[T](t: Throwable): TryFailureCheckedMatcher[T]
Inherited from
TryMatchers
def aFailedTry[T](check: ValueCheck[Throwable]): TryFailureCheckedMatcher[T]
Inherited from
TryMatchers
Inherited from
TryMatchers
def aSuccessfulTry[T](t: T)(using `evidence$2`: Diffable[T]): TrySuccessCheckedMatcher[T]
Inherited from
TryMatchers
def allOf[T](checks: ValueCheck[T]*): ContainWithResultSeq[T]
override def anError: Error
Definition Classes
ThrownStandardResults -> StandardResults
Inherited from
ThrownStandardResults
def anError(message: String): Error
Inherited from
StandardResults
def anyOf[T](t: T*): Matcher[T]

alias for beOneOf, which can be used with contain matchers

alias for beOneOf, which can be used with contain matchers

Inherited from
AnyMatchers
def asNoneAs[T](other: => Option[T]): Matcher[Option[T]]
Inherited from
OptionMatchers
def atLeast[T](checks: ValueCheck[T]*): ContainWithResultSeq[T]
def atMost[T](checks: ValueCheck[T]*): ContainWithResultSeq[T]
def await[T](m: Matcher[T])(retries: Int, timeout: FiniteDuration)(using ee: ExecutionEnv): Matcher[Future[T]]
Inherited from
FutureMatchers
def await[T](m: Matcher[T])(using ee: ExecutionEnv, nothing: Int): Matcher[Future[T]]
Inherited from
FutureMatchers
def awaitFor[T](m: Matcher[T])(timeout: FiniteDuration)(using ee: ExecutionEnv): Matcher[Future[T]]
Inherited from
FutureMatchers
def be[T <: AnyRef](t: => T): BeTheSameAs[T]

alias for beTheSameAs

alias for beTheSameAs

Inherited from
AnyMatchers
def beAFailedTry[T](check: ValueCheck[Throwable]): TryFailureCheckedMatcher[T]
Inherited from
TryMatchers
Inherited from
TryMatchers
def beAnInstanceOf[T](using `evidence$14`: ClassTag[T]): Matcher[AnyRef]
Inherited from
AnyMatchers
def beAnyOf[T](t: T*): Matcher[T]

alias for beOneOf

alias for beOneOf

Inherited from
AnyMatchers
def beAsNoneAs[T](other: => Option[T]): Matcher[Option[T]]
Inherited from
OptionMatchers
def beAsNullAs[T](a: => T): Matcher[T]

matches if a is null when v is null and a is not null when v is not null

matches if a is null when v is null and a is not null when v is not null

Inherited from
AnyMatchers
def beAssignableFrom[T](using `evidence$13`: ClassTag[T]): Matcher[Class[_]]

matches if v.isAssignableFrom(c)

matches if v.isAssignableFrom(c)

Inherited from
AnyMatchers
def beBetween[T](t1: T, t2: T)(using `evidence$40`: Ordering[T]): BetweenMatcher[T]

matches if a value is between 2 others according to an Ordering

matches if a value is between 2 others according to an Ordering

Inherited from
NumericMatchers
def beCloseTo[S](target: SignificantTarget[S])(using `evidence$37`: Numeric[S]): Matcher[S]
Inherited from
NumericMatchers
def beCloseTo[S](target: S, figures: SignificantFigures)(using `evidence$36`: Numeric[S]): Matcher[S]

matches if target - actual < 10 pow (log actual - significantDigits)

matches if target - actual < 10 pow (log actual - significantDigits)

Inherited from
NumericMatchers
def beCloseTo[S](delta: PlusOrMinus[S])(using `evidence$30`: Numeric[S]): Matcher[S]

matches if actual = n +/- delta

matches if actual = n +/- delta

Inherited from
NumericMatchers
def beCloseTo[S](n: S, delta: S)(using `evidence$28`: Numeric[S]): Matcher[S]

matches if actual = n +/- delta

matches if actual = n +/- delta

Inherited from
NumericMatchers
def beDefinedAt[K](values: K*): Matcher[PartialFunction[K, Any]]

matches if the partial function is defined at those values

matches if the partial function is defined at those values

Inherited from
MapMatchers
def beDefinedBy[K, V](values: (K, V)*): Matcher[PartialFunction[K, V]]

matches if the partial function is defined at those values and return expected values

matches if the partial function is defined at those values and return expected values

Inherited from
MapMatchers
def beEmpty[T](using `evidence$9`: IsEmpty[T]): Matcher[T]

matches if a.isEmpty

matches if a.isEmpty

Inherited from
AnyMatchers
def beEqualTo[T](t: => T)(using `evidence$5`: Diffable[T]): EqualityMatcher[T]

matches if a == b

matches if a == b

Inherited from
AnyMatchers
def beFailedTry[T](check: ValueCheck[Throwable]): TryFailureCheckedMatcher[T]
Inherited from
TryMatchers
Inherited from
TryMatchers
def beFalse: Matcher[Boolean]

matches if a == false

matches if a == false

Inherited from
AnyMatchers
def beGreaterThan[S](n: S)(using `evidence$24`: Ordering[S]): BeGreaterThan[S]

matches if actual > n

matches if actual > n

Inherited from
NumericMatchers
def beGreaterThanOrEqualTo[S](n: S)(using `evidence$20`: Ordering[S]): Matcher[S]

matches if actual >= n

matches if actual >= n

Inherited from
NumericMatchers
def beLeft[T](using p: ImplicitParam): LeftMatcher[T]
Inherited from
EitherMatchers
Inherited from
EitherMatchers
def beLessThan[S](n: S)(using `evidence$16`: Ordering[S]): BeLessThan[S]

matches if actual < n

matches if actual < n

Inherited from
NumericMatchers
def beLessThanOrEqualTo[S](n: S)(using `evidence$12`: Ordering[S]): BeLessThanOrEqualTo[S]

matches if actual <= n

matches if actual <= n

Inherited from
NumericMatchers
def beLike[T](pattern: PartialFunction[T, Result]): Matcher[T]

matches if the value returns a successful result when applied to a PartialFunction

matches if the value returns a successful result when applied to a PartialFunction

Inherited from
AnyMatchers
def beMatching[T](t: => T)(using `evidence$2`: MatchingExpression[T]): Matcher[String]

matches if b matches the regular expression a

matches if b matches the regular expression a

Inherited from
StringMatchers
def beMatchingWithPart[T](t: T)(using `evidence$4`: MatchingExpression[T]): Matcher[String]

alias for beMatching but matching just a fragment of the string

alias for beMatching but matching just a fragment of the string

Inherited from
StringMatchers
def beNone: Matcher[Option[Any]]
Inherited from
OptionMatchers
def beNull[T]: BeNull[T]

matches if the value is null

matches if the value is null

Inherited from
AnyMatchers
def beOneOf[T](t: T*): Matcher[T]

matches if t.toSeq.exists(_ == v)

matches if t.toSeq.exists(_ == v)

Inherited from
AnyMatchers
def beRight[T](using p: ImplicitParam): RightMatcher[T]
Inherited from
EitherMatchers
Inherited from
EitherMatchers
def beSome[T](using p: ImplicitParam): SomeMatcher[T]
Inherited from
OptionMatchers
def beSome[T](check: ValueCheck[T]): SomeCheckedMatcher[T]
Inherited from
OptionMatchers
def beSorted[T](using `evidence$14`: Ordering[T]): OrderingMatcher[T]
Returns

a matcher checking if the elements are ordered

Inherited from
TraversableBaseMatchers
def beTheSameAs[T <: AnyRef](t: => T): BeTheSameAs[T]

matches if a eq b

matches if a eq b

Inherited from
AnyMatchers
def beTrue: Matcher[Boolean]

matches if a == true

matches if a == true

Inherited from
AnyMatchers
def be_!=[T](t: => T)(using `evidence$2`: Diffable[T]): Matcher[T]

matches if a != b

matches if a != b

Inherited from
AnyMatchers
def be_!=/(a: String): Matcher[String]

matches if a.toLowerCase.trim != b.toLowerCase.trim

matches if a.toLowerCase.trim != b.toLowerCase.trim

Inherited from
StringMatchers
def be_<[S](n: S)(using `evidence$18`: Ordering[S]): BeLessThan[S]

alias for beLessThan

alias for beLessThan

Inherited from
NumericMatchers
def be_<=[S](n: S)(using `evidence$14`: Ordering[S]): BeLessThanOrEqualTo[S]

alias for beLessThanOrEqualTo

alias for beLessThanOrEqualTo

Inherited from
NumericMatchers
def be_==[T](t: => T)(using `evidence$1`: Diffable[T]): EqualityMatcher[T]

matches if a == b

matches if a == b

Inherited from
AnyMatchers
def be_==/(a: String): Matcher[String]

matches if a.toLowerCase.trim = b.toLowerCase.trim

matches if a.toLowerCase.trim = b.toLowerCase.trim

Inherited from
StringMatchers
def be_==~[T, S](s: => S)(using `evidence$7`: Diffable[T], convert: Conversion[S, T]): Matcher[T]

matches if a == b after an implicit conversion

matches if a == b after an implicit conversion

Inherited from
AnyMatchers
def be_>[S](n: S)(using `evidence$26`: Ordering[S]): BeGreaterThan[S]

alias for beGreaterThan

alias for beGreaterThan

Inherited from
NumericMatchers
def be_>=[S](n: S)(using `evidence$22`: Ordering[S]): Matcher[S]

alias for beGreaterThanOrEqualTo

alias for beGreaterThanOrEqualTo

Inherited from
NumericMatchers
def be_~[S](delta: PlusOrMinus[S])(using `evidence$35`: Numeric[S]): Matcher[S]

alias for beCloseTo

alias for beCloseTo

Inherited from
NumericMatchers
def be_~[S](n: S)(delta: S)(using `evidence$33`: Numeric[S]): Matcher[S]

alias for beCloseTo

alias for beCloseTo

Inherited from
NumericMatchers
def between[T](t1: T, t2: T)(using `evidence$41`: Ordering[T]): BetweenMatcher[T]
Inherited from
NumericMatchers
override protected def checkResultFailure(result: => Result): Result
Definition Classes
Inherited from
ThrownExpectables
def closeTo[S](target: SignificantTarget[S])(using `evidence$39`: Numeric[S]): Matcher[S]
Inherited from
NumericMatchers
def closeTo[S](target: S, figures: SignificantFigures)(using `evidence$38`: Numeric[S]): Matcher[S]
Inherited from
NumericMatchers
def closeTo[S](delta: PlusOrMinus[S])(using `evidence$31`: Numeric[S]): Matcher[S]
Inherited from
NumericMatchers
def closeTo[S](n: S, delta: S)(using `evidence$29`: Numeric[S]): Matcher[S]
Inherited from
NumericMatchers
def contain(t: Char): Matcher[String]

matches if (b contains a)

matches if (b contains a)

Inherited from
StringMatchers
def contain(t: String): Matcher[String]

matches if (b contains a)

matches if (b contains a)

Inherited from
StringMatchers
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T], t10: ValueCheck[T], t11: ValueCheck[T], t12: ValueCheck[T], t13: ValueCheck[T], t14: ValueCheck[T], t15: ValueCheck[T], t16: ValueCheck[T], t17: ValueCheck[T], t18: ValueCheck[T], t19: ValueCheck[T], t20: ValueCheck[T], t21: ValueCheck[T], t22: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T], t10: ValueCheck[T], t11: ValueCheck[T], t12: ValueCheck[T], t13: ValueCheck[T], t14: ValueCheck[T], t15: ValueCheck[T], t16: ValueCheck[T], t17: ValueCheck[T], t18: ValueCheck[T], t19: ValueCheck[T], t20: ValueCheck[T], t21: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T], t10: ValueCheck[T], t11: ValueCheck[T], t12: ValueCheck[T], t13: ValueCheck[T], t14: ValueCheck[T], t15: ValueCheck[T], t16: ValueCheck[T], t17: ValueCheck[T], t18: ValueCheck[T], t19: ValueCheck[T], t20: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T], t10: ValueCheck[T], t11: ValueCheck[T], t12: ValueCheck[T], t13: ValueCheck[T], t14: ValueCheck[T], t15: ValueCheck[T], t16: ValueCheck[T], t17: ValueCheck[T], t18: ValueCheck[T], t19: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T], t10: ValueCheck[T], t11: ValueCheck[T], t12: ValueCheck[T], t13: ValueCheck[T], t14: ValueCheck[T], t15: ValueCheck[T], t16: ValueCheck[T], t17: ValueCheck[T], t18: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T], t10: ValueCheck[T], t11: ValueCheck[T], t12: ValueCheck[T], t13: ValueCheck[T], t14: ValueCheck[T], t15: ValueCheck[T], t16: ValueCheck[T], t17: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T], t10: ValueCheck[T], t11: ValueCheck[T], t12: ValueCheck[T], t13: ValueCheck[T], t14: ValueCheck[T], t15: ValueCheck[T], t16: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T], t10: ValueCheck[T], t11: ValueCheck[T], t12: ValueCheck[T], t13: ValueCheck[T], t14: ValueCheck[T], t15: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T], t10: ValueCheck[T], t11: ValueCheck[T], t12: ValueCheck[T], t13: ValueCheck[T], t14: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T], t10: ValueCheck[T], t11: ValueCheck[T], t12: ValueCheck[T], t13: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T], t10: ValueCheck[T], t11: ValueCheck[T], t12: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T], t10: ValueCheck[T], t11: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T], t10: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T], t9: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T], t8: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T], t7: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T]): ContainWithResultSeq[T]
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T]): ContainWithResultSeq[T]

Additional contain methods using to avoid automatic tuple conversions

Additional contain methods using to avoid automatic tuple conversions

Inherited from
TraversableBaseMatchers

COLLECTION MATCHERS

COLLECTION MATCHERS

Inherited from
TraversableBaseMatchers
def contain[T](check: ValueCheck[T]): ContainWithResult[T]

ELEMENTS MATCHERS

ELEMENTS MATCHERS

Inherited from
TraversableBaseMatchers
def containAllOf[T](seq: Seq[T])(using `evidence$4`: Diffable[T]): ContainWithResultSeq[T]

match if a traversable contains all the elements of seq (and maybe more)

match if a traversable contains all the elements of seq (and maybe more)

Inherited from
TraversableBaseMatchers
def containAnyOf[T](seq: Seq[T]): ContainWithResult[T]

match if a traversable contains one of (t1, t2)

match if a traversable contains one of (t1, t2)

Inherited from
TraversableBaseMatchers
def containMatch[T](s: => String): Matcher[Iterable[T]]

match if traversable contains (x matches .+t+.)

match if traversable contains (x matches .+t+.)

Inherited from
TraversableBaseMatchers
def containPattern[T, S](s: S)(using `evidence$5`: MatchingExpression[S]): Matcher[Iterable[T]]

match if traversable contains (x matches p)

match if traversable contains (x matches p)

Inherited from
TraversableBaseMatchers
def containTheSameElementsAs[T](seq: Seq[T], equality: (T, T) => Boolean): Matcher[Iterable[T]]

does a containAll comparison in both ways

does a containAll comparison in both ways

Inherited from
TraversableBaseMatchers
def createExpectable[T](t: => T, alias: String => String): Expectable[T]
Returns

an Expectable with a description function

Inherited from
ExpectationsCreation
def createExpectable[T](t: => T, alias: => String): Expectable[T]
Returns

an Expectable with a description

Inherited from
ExpectationsCreation
def createExpectable[T](t: => T): Expectable[T]
Returns

an Expectable

Inherited from
ExpectationsCreation
override def createExpectable[T](t: => T, alias: Option[String => String]): Expectable[T]
Returns

an Expectable with a description function

Definition Classes
Inherited from
ThrownExpectables
def createExpectableWithShowAs[T](t: => T, showAs: => String): Expectable[T]
Returns

an Expectable with a function to show the element T

Inherited from
ExpectationsCreation
def done: Success
Inherited from
StandardResults
def eachOf[T](checks: ValueCheck[T]*): ContainWithResultSeq[T]
def endWith(t: => String): Matcher[String]

matches if b.endsWith(a)

matches if b.endsWith(a)

Inherited from
StringMatchers
def equalTo[T](t: => T)(using `evidence$6`: Diffable[T]): EqualityMatcher[T]

matches if a == b

matches if a == b

Inherited from
AnyMatchers
def eventually[T](nested: => Matcher[T]): Matcher[T]
Returns

a matcher that will retry the nested matcher 40 times

Inherited from
EventuallyMatchers
def eventually[T](nested: => Matcher[T], retries: Int, sleep: Duration): Matcher[T]
Returns

a matcher that will retry the nested matcher a given number of times

Inherited from
EventuallyMatchers
def eventually[T](nested: => Matcher[T], retries: Int, sleep: Int => Duration): Matcher[T]
Value Params
sleep

the function applied on the retry number (first is 1)

Returns

a matcher that will retry the nested matcher a given number of times

Inherited from
EventuallyMatchers
def eventually[T](result: => T)(using `evidence$3`: AsResult[T]): T
Returns

a result that is retried at least 40 times until it's ok

Inherited from
EventuallyResults
def eventually[T](retries: Int, sleep: Duration)(result: => T)(using `evidence$2`: AsResult[T]): T
Returns

a matcher that will retry the nested matcher a given number of times

Inherited from
EventuallyResults
def eventually[T](retries: Int, sleep: Int => Duration)(result: => T)(using `evidence$1`: AsResult[T]): T
Value Params
sleep

the function applied on the retry number (first is 1)

Returns

a matcher that will retry the nested matcher a given number of times

eventually(retries = 2, sleep = _ * 100.milliseconds) {
 aResult
}
Inherited from
EventuallyResults
def exactly[T](checks: ValueCheck[T]*): ContainWithResultSeq[T]
def failedTry[T](t: Throwable): TryFailureCheckedMatcher[T]
Inherited from
TryMatchers
def failedTry[T](check: ValueCheck[Throwable]): TryFailureCheckedMatcher[T]
Inherited from
TryMatchers
Inherited from
TryMatchers
protected def failure(f: Failure): Failure
Inherited from
ThrownStandardResults
override def failure(m: String): Failure
Definition Classes
ThrownStandardResults -> StandardResults
Inherited from
ThrownStandardResults
override def failure: Failure
Definition Classes
ThrownStandardResults -> StandardResults
Inherited from
ThrownStandardResults
def find(r: Regex): FindMatcherRegex

matches if the regexp r is found inside b

matches if the regexp r is found inside b

Inherited from
StringMatchers
def find(p: Pattern): FindMatcherPattern

matches if the pattern p is found inside b

matches if the pattern p is found inside b

Inherited from
StringMatchers
def find(a: => String): FindMatcher

matches if the regexp a is found inside b

matches if the regexp a is found inside b

Inherited from
StringMatchers
def greaterThan[S](n: S)(using `evidence$25`: Ordering[S]): BeGreaterThan[S]
Inherited from
NumericMatchers
def greaterThanOrEqualTo[S](n: S)(using `evidence$21`: Ordering[S]): Matcher[S]
Inherited from
NumericMatchers
def haveClass[T](using `evidence$10`: ClassTag[T]): Matcher[AnyRef]

matches if v.getClass == c

matches if v.getClass == c

Inherited from
AnyMatchers
def haveInterface[T](using `evidence$12`: ClassTag[T]): Matcher[AnyRef]

matches if x.getClass.getInterfaces.contains(T)

matches if x.getClass.getInterfaces.contains(T)

Inherited from
AnyMatchers
def haveKey[K](k: K): Matcher[Iterable[(K, Any)]]

matches if map.contains(k)

matches if map.contains(k)

Inherited from
MapMatchers
def haveKeys[K](keys: K*): Matcher[Iterable[(K, Any)]]

matches if map.contains(k) forall key k

matches if map.contains(k) forall key k

Inherited from
MapMatchers
def haveLength[T](check: ValueCheck[Int])(using `evidence$12`: Sized[T]): SizedCheckedMatcher[T]

alias for haveSize

alias for haveSize

Inherited from
TraversableBaseMatchers
def haveLength[T](n: Int)(using `evidence$8`: Sized[T]): SizedMatcher[T]

alias for haveSize

alias for haveSize

Inherited from
TraversableBaseMatchers
def havePair[K, V](p: (K, V)): Matcher[Iterable[(K, V)]]

matches if map contains a pair (key, value) == (k, v)

matches if map contains a pair (key, value) == (k, v)

Inherited from
MapMatchers
def havePairs[K, V](pairs: (K, V)*): Matcher[Iterable[(K, V)]]

matches if map contains all the specified pairs

matches if map contains all the specified pairs

Inherited from
MapMatchers
def haveSize[T](check: ValueCheck[Int])(using `evidence$10`: Sized[T]): SizedCheckedMatcher[T]

match if there is a way to size T

match if there is a way to size T

Inherited from
TraversableBaseMatchers
def haveSize[T](n: Int)(using `evidence$6`: Sized[T]): SizedMatcher[T]

match if there is a way to size T

match if there is a way to size T

Inherited from
TraversableBaseMatchers
def haveSuperclass[T](using `evidence$11`: ClassTag[T]): Matcher[AnyRef]

matches if c.isAssignableFrom(v.getClass.getSuperclass)

matches if c.isAssignableFrom(v.getClass.getSuperclass)

Inherited from
AnyMatchers
def haveValue[V](v: V): Matcher[Iterable[(Any, V)]]

matches if map contains a pair (key, value) with value == v

matches if map contains a pair (key, value) with value == v

Inherited from
MapMatchers
def haveValues[V](values: V*): Matcher[Iterable[(Any, V)]]

matches if map contains a pair (key, value) with value == v for all value v

matches if map contains a pair (key, value) with value == v for all value v

Inherited from
MapMatchers
def ko(m: String): Result
Inherited from
ExpectedResults
Inherited from
EitherMatchers
def left[T](t: T)(using `evidence$2`: Diffable[T]): LeftCheckedMatcher[T]
Inherited from
EitherMatchers
def length[T](check: ValueCheck[Int])(using `evidence$13`: Sized[T]): SizedCheckedMatcher[T]

alias for haveSize

alias for haveSize

Inherited from
TraversableBaseMatchers
def length[T](n: Int)(using `evidence$9`: Sized[T]): SizedMatcher[T]

alias for haveSize

alias for haveSize

Inherited from
TraversableBaseMatchers
def lessThan[S](n: S)(using `evidence$17`: Ordering[S]): BeLessThan[S]
Inherited from
NumericMatchers
def lessThanOrEqualTo[S](n: S)(using `evidence$13`: Ordering[S]): BeLessThanOrEqualTo[S]

matches if actual <= n

matches if actual <= n

Inherited from
NumericMatchers
protected def mapResult(r: Result): Result

this method can be overridden to intercept a Result and modify it. It is used for example to set a stacktrace providing the location of a failure

this method can be overridden to intercept a Result and modify it. It is used for example to set a stacktrace providing the location of a failure

Inherited from
ResultChecks
def matching[T](t: => T)(using `evidence$3`: MatchingExpression[T]): Matcher[String]

alias to use with contain

alias to use with contain

Inherited from
StringMatchers
def none: Matcher[Option[Any]]
Inherited from
OptionMatchers
def not[T](m: Matcher[T]): Matcher[T]

negate a matcher

negate a matcher

Inherited from
AnyMatchers
def ok(m: String): Result
Inherited from
ExpectedResults
protected def pending(p: Pending): Pending
Inherited from
ThrownStandardResults
override def pending(m: String): Pending
Definition Classes
ThrownStandardResults -> StandardResults
Inherited from
ThrownStandardResults
override def pending: Pending
Definition Classes
ThrownStandardResults -> StandardResults
Inherited from
ThrownStandardResults
def pending[R](r: => R)(using `evidence$1`: AsResult[R]): Pending
Inherited from
StandardResults
def retry[T](m: Matcher[T])(retries: Int)(using ee: ExecutionEnv): Matcher[Future[T]]
Inherited from
FutureMatchers
Inherited from
EitherMatchers
def right[T](t: T)(using `evidence$1`: Diffable[T]): RightCheckedMatcher[T]
Inherited from
EitherMatchers
override def sandboxResult(r: => Result): Result
Returns

the value without any side-effects for expectations

Definition Classes
Inherited from
ThrownStandardMatchResults
override def setStacktrace(r: Result): Result
def size[T](check: ValueCheck[Int])(using `evidence$11`: Sized[T]): SizedCheckedMatcher[T]

alias for haveSize

alias for haveSize

Inherited from
TraversableBaseMatchers
def size[T](n: Int)(using `evidence$7`: Sized[T]): SizedMatcher[T]

alias for haveSize

alias for haveSize

Inherited from
TraversableBaseMatchers
protected def skipped(s: Skipped): Skipped
Inherited from
ThrownStandardResults
override def skipped(m: String): Skipped
Definition Classes
ThrownStandardResults -> StandardResults
Inherited from
ThrownStandardResults
override def skipped: Skipped
Definition Classes
ThrownStandardResults -> StandardResults
Inherited from
ThrownStandardResults
def skipped[R](r: => R)(using `evidence$2`: AsResult[R]): Skipped
Inherited from
StandardResults
def some[T]: SomeMatcher[T]
Inherited from
OptionMatchers
def some[T](check: ValueCheck[T]): SomeCheckedMatcher[T]
Inherited from
OptionMatchers
def some[T](t: T)(using `evidence$3`: Diffable[T]): SomeCheckedMatcher[T]
Inherited from
OptionMatchers
def sorted[T](using `evidence$15`: Ordering[T]): OrderingMatcher[T]

alias for beSorted

alias for beSorted

Inherited from
TraversableBaseMatchers
def startWith(a: String): Matcher[String]

matches if b.startsWith(a)

matches if b.startsWith(a)

Inherited from
StringMatchers
override def success(m: String): Success
Definition Classes
ThrownStandardResults -> StandardResults
Inherited from
ThrownStandardResults
def successfulTry[T](t: T)(using `evidence$1`: Diffable[T]): TrySuccessCheckedMatcher[T]
Inherited from
TryMatchers
Inherited from
TryMatchers
def theBlock(t: => Nothing): Expectable[Nothing]
Inherited from
ExpectationsCreation
def theValue[T](t: => T): Expectable[T]
Inherited from
ExpectationsCreation
def throwA[E <: Throwable](e: E): ExceptionMatcher[E]
Returns

a matcher checking the value of an Exception

Inherited from
ExceptionMatchers
def throwA[E <: Throwable](message: String)(using m: ClassTag[E]): Matcher[Any]
Returns

a matcher checking the type of an Exception and its message (as a regexp)

Inherited from
ExceptionMatchers
def throwA[E <: Throwable](using m: ClassTag[E]): ExceptionClassMatcher
Returns

a matcher checking the type of an Exception

Inherited from
ExceptionMatchers
def throwAn[E <: Throwable](e: E): ExceptionMatcher[E]

alias for throwA

alias for throwA

Inherited from
ExceptionMatchers
def throwAn[E <: Throwable](message: String)(using m: ClassTag[E]): Matcher[Any]

alias for throwA

alias for throwA

Inherited from
ExceptionMatchers
def throwAn[E <: Throwable](using m: ClassTag[E]): ExceptionClassMatcher

alias for throwA

alias for throwA

Inherited from
ExceptionMatchers
override def todo: Pending
Definition Classes
ThrownStandardResults -> StandardResults
Inherited from
ThrownStandardResults
def valueIsTypedValueCheck[T](expected: T)(using di: Diffable[T]): BeEqualTypedValueCheck[T]

an expected value can be used to check another value

an expected value can be used to check another value

Inherited from
ValueChecksBase
def wontdo: Success
Inherited from
StandardResults
def ~[S](delta: PlusOrMinus[S])(using `evidence$34`: Numeric[S]): Matcher[S]

alias for beCloseTo

alias for beCloseTo

Inherited from
NumericMatchers
def ~[S](n: S)(delta: S)(using `evidence$32`: Numeric[S]): Matcher[S]

alias for beCloseTo

alias for beCloseTo

Inherited from
NumericMatchers

Inherited fields

Inherited from
ImplicitParameters
Inherited from
ImplicitParameters
Inherited from
ImplicitParameters
Inherited from
ImplicitParameters
Inherited from
ImplicitParameters
Inherited from
ImplicitParameters
Inherited from
ImplicitParameters
Inherited from
ImplicitParameters
Inherited from
ImplicitParameters
Inherited from
ImplicitParameters
Inherited from
ImplicitParameters
lazy override val ko: Result
lazy val ok: Result
Inherited from
ExpectedResults
lazy override val success: Success
Inherited from
ThrownStandardResults

Givens

Inherited givens

a check of type T can be downcasted implicitly to a check of type S >: T

a check of type T can be downcasted implicitly to a check of type S >: T

Inherited from
ValueChecks
given functionIsValueCheck[T, R]: Conversion[T => R, ValueCheck[T]]

a function returning an object having an AsResult instance can check a value

a function returning an object having an AsResult instance can check a value

Inherited from
ValueChecksLowImplicits
given given_Conversion_S_CanHaveDelta[S]: Conversion[S, CanHaveDelta[S]]

implicit definition to create delta for the beCloseTo matcher

implicit definition to create delta for the beCloseTo matcher

Inherited from
NumericMatchers
given matcherIsValueCheck[T]: Conversion[Matcher[T], ValueCheck[T]]

a Matcher[T] can check a value

a Matcher[T] can check a value

Inherited from
ValueChecksBase
given matchersToValueChecks[T]: Conversion[Seq[Matcher[T]], Seq[ValueCheck[T]]]
given partialfunctionIsValueCheck[T, R]: Conversion[PartialFunction[T, R], ValueCheck[T]]

a partial function returning an object having an AsResult instance can check a value

a partial function returning an object having an AsResult instance can check a value

Inherited from
ValueChecks
given seqToValueChecks[T](using val to: T => ValueCheck[T]): Conversion[Seq[T], Seq[ValueCheck[T]]]

Extensions

Inherited extensions

extension (m: AdaptableMatcher[String])

adapt the BeEqualTo matcher to provide ignoreCase and ignoreSpace matcher

adapt the BeEqualTo matcher to provide ignoreCase and ignoreSpace matcher

Inherited from
StringMatchers

adapt the BeEqualTo matcher to provide ignoreCase and ignoreSpace matcher

adapt the BeEqualTo matcher to provide ignoreCase and ignoreSpace matcher

Inherited from
StringMatchers

adapt the BeEqualTo matcher to provide ignoreCase and ignoreSpace matcher

adapt the BeEqualTo matcher to provide ignoreCase and ignoreSpace matcher

Inherited from
StringMatchers
extension (m: Matcher[T])
def await[T](using ee: ExecutionEnv)(retries: Int, timeout: FiniteDuration): Matcher[Future[T]]

add an await method to any matcher Matcher[T] so that it can be transformed into a Matcher[Future[T]] making this implicit an extension method does not work out of the box

add an await method to any matcher Matcher[T] so that it can be transformed into a Matcher[Future[T]] making this implicit an extension method does not work out of the box

Inherited from
FutureMatchers
def await[T](using ee: ExecutionEnv): Matcher[Future[T]]

add an await method to any matcher Matcher[T] so that it can be transformed into a Matcher[Future[T]] making this implicit an extension method does not work out of the box

add an await method to any matcher Matcher[T] so that it can be transformed into a Matcher[Future[T]] making this implicit an extension method does not work out of the box

Inherited from
FutureMatchers
def awaitFor[T](using ee: ExecutionEnv)(timeout: FiniteDuration): Matcher[Future[T]]

add an await method to any matcher Matcher[T] so that it can be transformed into a Matcher[Future[T]] making this implicit an extension method does not work out of the box

add an await method to any matcher Matcher[T] so that it can be transformed into a Matcher[Future[T]] making this implicit an extension method does not work out of the box

Inherited from
FutureMatchers
def retryAwait[T](using ee: ExecutionEnv)(retries: Int): Matcher[Future[T]]

add an await method to any matcher Matcher[T] so that it can be transformed into a Matcher[Future[T]] making this implicit an extension method does not work out of the box

add an await method to any matcher Matcher[T] so that it can be transformed into a Matcher[Future[T]] making this implicit an extension method does not work out of the box

Inherited from
FutureMatchers
extension (n: Int)
def times(using not: NotGiven[NoNumberOfTimes]): Times

This implicit definition allows to declare a number of times 3.times

This implicit definition allows to declare a number of times 3.times

Inherited from
NumberOfTimes
extension (t: => T)
def !==[T](using not: NotGiven[NoTypedEqual])(other: => T): Result

! equality matcher on Expectables

! equality matcher on Expectables

Inherited from
TypedEqual
def ===[T](using not: NotGiven[NoTypedEqual])(other: => T): Result

equality matcher on Expectables

equality matcher on Expectables

Inherited from
TypedEqual
extension (target: N)
def within[N](significant: SignificantFigures)(using `evidence$11`: Numeric[N]): SignificantTarget[N]

implicit definition to create significant figures for the beCloseTo matcher

implicit definition to create significant figures for the beCloseTo matcher

Inherited from
NumericMatchers
extension (value: Int)

implicit definition to create significant figures for the beCloseTo matcher

implicit definition to create significant figures for the beCloseTo matcher

Inherited from
NumericMatchers

implicit definition to create significant figures for the beCloseTo matcher

implicit definition to create significant figures for the beCloseTo matcher

Inherited from
NumericMatchers

Implicits

Inherited implicits

implicit def futureToResult[T](f: => Future[T])(using ee: ExecutionEnv, asResult: AsResult[T]): FutureAsResult[T]

when a Future contains a result, it can be awaited to return this result

when a Future contains a result, it can be awaited to return this result

Inherited from
FutureMatchers