Specification

abstract class Specification extends SpecificationLike

Immutable Specification class

It contains all necessary functionalities to create specifications:

  • create fragments
  • create expectations
trait ImplicitExecutionContexts
trait ImplicitExecutionContextFromExecutionEnv
trait Debug
trait ResultLogicalCombinators
trait Results
trait MatcherImplicits
trait ExpectedResults
trait StandardResults
trait Expectations
trait ExpectationsDescription
trait ShouldMatchers
trait ShouldExpectations
trait MustMatchers
trait MustExpectations
trait TypedEqual
trait Matchers
trait FutureMatchers
trait EventuallyMatchers
trait EventuallyResults
trait TryMatchers
trait EitherMatchers
trait OptionMatchers
trait ValueChecks
trait ValueChecksBase
trait NumericMatchers
trait ExceptionMatchers
trait ExpectationsCreation
trait ResultChecks
trait MatchResultStackTrace
trait StringMatchers
trait MapMatchers
trait TraversableMatchers
trait NumberOfTimes
trait ImplicitParameters
trait TraversableBaseMatchersLowImplicits
trait ValueChecksLowImplicits
trait TraversableBaseMatchers
trait AnyMatchers
trait S2StringContext1
trait ArgumentsShortcuts
trait ArgumentsArgs
trait ArgProperties
trait ArgumentsCreation
trait TitleDsl
trait AcceptanceDsl1
trait ActionDsl
trait TagDsl
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 ResultLogicalCombinator(res: => Result)
trait ToFragments[T]
Inherited from
FragmentsDsl
trait ToSpecStructure[T1, T2]
Inherited from
SpecStructureDsl
class appendFragments[T1, T2](t1: T1)(using evidence$1: ToFragments[T1], evidence$2: ToFragments[T2])
Inherited from
FragmentsDsl
class appendSpecStructure[T1, T2](t1: T1)(using tss: ToSpecStructure[T1, T2])
Inherited from
SpecStructureDsl
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
def aFailedTry[T]: TryFailureMatcher[T]
Inherited from
TryMatchers
def aSuccessfulTry[T](t: T)(using evidence$2: Diffable[T]): TrySuccessCheckedMatcher[T]
Inherited from
TryMatchers
def aSuccessfulTry[T](check: ValueCheck[T]): TrySuccessCheckedMatcher[T]
Inherited from
TryMatchers
def aSuccessfulTry[T]: TrySuccessMatcher[T]
Inherited from
TryMatchers
def action[T](a: => T)(using evidence$3: AsExecution[T]): Fragment
Inherited from
ActionDsl
def addExample(d: String, execution: => Execution): Fragment
Inherited from
ExampleDsl
def allOf[T](checks: ValueCheck[T]*): ContainWithResultSeq[T]
Inherited from
TraversableBaseMatchers
def anError(message: String): Error
Inherited from
StandardResults
def anError: 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 args(ex: ArgProperty[String], include: ArgProperty[String], exclude: ArgProperty[String], was: ArgProperty[String], plan: ArgProperty[Boolean], skipAll: ArgProperty[Boolean], stopOnFail: ArgProperty[Boolean], stopOnError: ArgProperty[Boolean], stopOnIssue: ArgProperty[Boolean], stopOnSkip: ArgProperty[Boolean], sequential: ArgProperty[Boolean], sequentialRandom: ArgProperty[Boolean], batchSize: ArgProperty[Int], timeFactor: ArgProperty[Int], timeout: ArgProperty[FiniteDuration], asap: ArgProperty[Boolean], xonly: ArgProperty[Boolean], showOnly: ArgProperty[String], color: ArgProperty[Boolean]): Arguments

shorthand method to create an Arguments object

shorthand method to create an Arguments object

Inherited from
ArgumentsCreation
def asNoneAs[T](other: => Option[T]): Matcher[Option[T]]
Inherited from
OptionMatchers
def atLeast[T](checks: ValueCheck[T]*): ContainWithResultSeq[T]
Inherited from
TraversableBaseMatchers
def atLeastOnceWhen[T, R](values: Iterable[T])(f: PartialFunction[T, R])(using evidence$15: AsResult[R]): Result

verify the function f for at least one value, where the PartialFunction is defined

verify the function f for at least one value, where the PartialFunction is defined

Inherited from
MatcherImplicits
def atMost[T](checks: ValueCheck[T]*): ContainWithResultSeq[T]
Inherited from
TraversableBaseMatchers
def atMostOnceWhen[T, R](values: Iterable[T])(f: PartialFunction[T, R])(using evidence$16: AsResult[R]): Result

verify the function f for at least one value, where the PartialFunction is defined

verify the function f for at least one value, where the PartialFunction is defined

Inherited from
MatcherImplicits
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 batchSize(n: Int): Arguments
Returns

arguments for a specification where examples must in a given batch size

Inherited from
ArgumentsShortcuts
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
def beAFailedTry[T]: TryFailureMatcher[T]
Inherited from
TryMatchers
def beASuccessfulTry[T](check: ValueCheck[T]): TrySuccessCheckedMatcher[T]
Inherited from
TryMatchers
def beASuccessfulTry[T]: TrySuccessMatcher[T]
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
def beFailedTry[T]: TryFailureMatcher[T]
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
def beLeft[T](t: ValueCheck[T]): LeftCheckedMatcher[T]
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
def beRight[T](t: ValueCheck[T]): RightCheckedMatcher[T]
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 beSuccessfulTry[T](check: ValueCheck[T]): TrySuccessCheckedMatcher[T]
Inherited from
TryMatchers
def beSuccessfulTry[T]: TrySuccessMatcher[T]
Inherited from
TryMatchers
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
def br: Fragment
Inherited from
FormattingFragments
def bt(n: Int): Fragment
Inherited from
FormattingFragments
def bt: Fragment
Inherited from
FormattingFragments
protected def checkResultFailure(r: => Result): Result

this method can be overridden to throw exceptions when checking a result

this method can be overridden to throw exceptions when checking a result

Inherited from
ResultChecks
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 colors(c: Colors): Arguments

shortcut to set new Colors

shortcut to set new Colors

Inherited from
ArgumentsShortcuts
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
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]
Inherited from
TraversableBaseMatchers
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T], t6: ValueCheck[T]): ContainWithResultSeq[T]
Inherited from
TraversableBaseMatchers
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T], t5: ValueCheck[T]): ContainWithResultSeq[T]
Inherited from
TraversableBaseMatchers
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T], t4: ValueCheck[T]): ContainWithResultSeq[T]
Inherited from
TraversableBaseMatchers
def contain[T](t1: ValueCheck[T], t2: ValueCheck[T], t3: ValueCheck[T]): ContainWithResultSeq[T]
Inherited from
TraversableBaseMatchers
def contain[T](t1: ValueCheck[T], t2: 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
def contain[T](cm: ContainWithResultSeq[T]): ContainWithResultSeq[T]

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
def createExpectable[T](t: => T, alias: Option[String => String]): Expectable[T]
Returns

an Expectable with a description function

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

an Expectable with a function to show the element T

Inherited from
ExpectationsCreation
def diffs(show: Boolean, separators: String, triggerSize: Int, diffRatio: Int, shortenSize: Int, full: Boolean, seqTriggerSize: Int, seqMaxSize: Int): Arguments

shortcut to display the differences with some specific parameters

shortcut to display the differences with some specific parameters

Inherited from
ArgumentsShortcuts
def done: Success
Inherited from
StandardResults
def eachOf[T](checks: ValueCheck[T]*): ContainWithResultSeq[T]
Inherited from
TraversableBaseMatchers
inline def eg[T](inline code: => T)(using asResult: AsResult[T]): Fragments
Inherited from
AutoExamples
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]
Inherited from
TraversableBaseMatchers
def exclude(tags: String): Arguments

shortcut to exclude some tagged fragments

shortcut to exclude some tagged fragments

Inherited from
ArgumentsShortcuts
def excludeAlsoTrace(patterns: String*): IncludeExcludeStackTraceFilter

shortcut to add exclude trace patterns

shortcut to add exclude trace patterns

Inherited from
ArgumentsShortcuts
def excludeTrace(patterns: String*): IncludeExcludeStackTraceFilter

shortcut to create a stackTrace filter to exclude only some elements

shortcut to create a stackTrace filter to exclude only some elements

Inherited from
ArgumentsShortcuts
def failedTry[T](t: Throwable): TryFailureCheckedMatcher[T]
Inherited from
TryMatchers
def failedTry[T](check: ValueCheck[Throwable]): TryFailureCheckedMatcher[T]
Inherited from
TryMatchers
def failedTry[T]: TryFailureMatcher[T]
Inherited from
TryMatchers
def failure(message: String): Failure
Inherited from
StandardResults
def failure: Failure
Inherited from
StandardResults
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

modify the fragments

modify the fragments

Inherited from
SpecificationStructure
def forall[T, R](values: Iterable[T])(f: T => R)(using evidence$11: AsResult[R]): Result

verify the function f for all the values, stopping after the first failure, where the PartialFunction is defined

verify the function f for all the values, stopping after the first failure, where the PartialFunction is defined

Inherited from
MatcherImplicits
def forallWhen[T, R](values: Iterable[T])(f: PartialFunction[T, R])(using evidence$12: AsResult[R]): Result
Inherited from
MatcherImplicits
def foreach[T, R](values: Iterable[T])(f: T => R)(using evidence$13: AsResult[R]): Result

verify the function f for all the values, and collect all failures

verify the function f for all the values, and collect all failures

Inherited from
MatcherImplicits
def foreachWhen[T, R](values: Iterable[T])(f: PartialFunction[T, R])(using evidence$14: AsResult[R]): Result

verify the function f for all the values, and collect all failures, where the PartialFunction is defined

verify the function f for all the values, and collect all failures, where the PartialFunction is defined

Inherited from
MatcherImplicits
def fragmentsBlock(fragments: Seq[Fragment], offset: Int): Fragments

create a block of new fragments where each of them is separated by a newline and there is a specific offset from the left margin

create a block of new fragments where each of them is separated by a newline and there is a specific offset from the left margin

Inherited from
FragmentsDsl
def fullStackTrace: Arguments

shortcut to filter nothing

shortcut to filter nothing

Inherited from
ArgumentsShortcuts
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 include(tags: String): Arguments

shortcut to include only some tagged fragments

shortcut to include only some tagged fragments

Inherited from
ArgumentsShortcuts
def includeAlsoTrace(patterns: String*): IncludeExcludeStackTraceFilter

shortcut to add include trace patterns

shortcut to add include trace patterns

Inherited from
ArgumentsShortcuts
def includeTrace(patterns: String*): IncludeExcludeStackTraceFilter

shortcut to create a stackTrace filter to include only some elements

shortcut to create a stackTrace filter to include only some elements

Inherited from
ArgumentsShortcuts
def ko(m: String): Result
Inherited from
ExpectedResults
def left[T](using p: ImplicitParam): LeftCheckedMatcher[ImplicitParam]
Inherited from
EitherMatchers
def left[T](t: ValueCheck[T]): LeftCheckedMatcher[T]
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
def map(fs: => Fragments): Fragments

modify the fragments

modify the fragments

Inherited from
SpecificationStructure
def map(structure: SpecStructure): SpecStructure

modify the specification structure

modify the specification structure

Inherited from
SpecificationStructure
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 negate(r: Result): Result
Inherited from
Results
def negateWhen(condition: Boolean)(r: Result): Result
Inherited from
Results
def nocolor: Arguments

shortcut to avoid colored output

shortcut to avoid colored output

Inherited from
ArgumentsShortcuts
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
def only(examples: String): Arguments

shortcut to execute and print only some examples

shortcut to execute and print only some examples

Inherited from
ArgumentsShortcuts
def p: Fragments
Inherited from
FormattingFragments
def pending[R](r: => R)(using evidence$1: AsResult[R]): Pending
Inherited from
StandardResults
def pending(message: String): Pending
Inherited from
StandardResults
def pending: Pending
Inherited from
StandardResults
def pendingUntilFixed[T](m: String)(t: => T)(using evidence$1: AsExecution[T]): Execution
Returns

Pending unless the result of the execution is a success

Inherited from
PendingUntilFixed
def plan: Arguments

shortcut to show only the text without any execution

shortcut to show only the text without any execution

Inherited from
ArgumentsShortcuts

this function is introduced just to allow the mutable specification to register the newly created fragments

this function is introduced just to allow the mutable specification to register the newly created fragments

Inherited from
AutoExamples

this function is exposed so that it can be overridden with side-effects when using s2 strings in mutable specs

this function is exposed so that it can be overridden with side-effects when using s2 strings in mutable specs

Inherited from
S2StringContextCreation
def retry[T](m: Matcher[T])(retries: Int)(using ee: ExecutionEnv): Matcher[Future[T]]
Inherited from
FutureMatchers
def right[T](using p: ImplicitParam): RightCheckedMatcher[ImplicitParam]
Inherited from
EitherMatchers
def right[T](t: ValueCheck[T]): RightCheckedMatcher[T]
Inherited from
EitherMatchers
def right[T](t: T)(using evidence$1: Diffable[T]): RightCheckedMatcher[T]
Inherited from
EitherMatchers
protected def sandboxResult(r: => Result): Result
Returns

the result without any side-effects

Inherited from
ResultChecks
def section(tag: NamedTag): Fragment
Inherited from
TagDsl
def section(names: String*): Fragment
Inherited from
TagDsl
def sequential: Arguments
Returns

arguments for a specification where examples must be executed sequentially

Inherited from
ArgumentsShortcuts
def sequentialRandom: Arguments
Returns

arguments for a specification where examples must be executed sequentially but in a random order

Inherited from
ArgumentsShortcuts
protected def setStacktrace(m: Result): Result

this method can be overridden to avoid filling-in a stacktrace indicating the location of the result

this method can be overridden to avoid filling-in a stacktrace indicating the location of the result

Inherited from
MatchResultStackTrace
def showOnly(s: String): Arguments

shortcut to print only some statuses

shortcut to print only some statuses

Inherited from
ArgumentsShortcuts
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
def skipAll: Arguments

shortcut to skip all examples

shortcut to skip all examples

Inherited from
ArgumentsShortcuts
def skipAllIf(condition: => Boolean): Arguments

shortcut to skip all examples when a condition is true. if the condition throws an exception, its stacktrace is not printed and all the examples are skipped

shortcut to skip all examples when a condition is true. if the condition throws an exception, its stacktrace is not printed and all the examples are skipped

Inherited from
ArgumentsShortcuts
def skipAllUnless(condition: => Boolean): Arguments

shortcut to skip all examples when a condition is false.

shortcut to skip all examples when a condition is false.

Inherited from
ArgumentsShortcuts
def skipped[R](r: => R)(using evidence$2: AsResult[R]): Skipped
Inherited from
StandardResults
def skipped(message: String): Skipped
Inherited from
StandardResults
def skipped: 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$1: 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
def step[T](a: => T, global: Boolean)(using evidence$2: AsExecution[T]): Fragment
Inherited from
ActionDsl
def step[T](a: => T)(using evidence$1: AsExecution[T]): Fragment
Inherited from
ActionDsl
def stopOnFail: Arguments

shortcut to stop after the first failure or error

shortcut to stop after the first failure or error

Inherited from
ArgumentsShortcuts
def stopOnSkip: Arguments

shortcut to stop after the first skipped result

shortcut to stop after the first skipped result

Inherited from
ArgumentsShortcuts
def success(message: String): Success
Inherited from
StandardResults
def success: Success
Inherited from
StandardResults
def successfulTry[T](t: T)(using evidence$1: Diffable[T]): TrySuccessCheckedMatcher[T]
Inherited from
TryMatchers
def successfulTry[T](check: ValueCheck[T]): TrySuccessCheckedMatcher[T]
Inherited from
TryMatchers
def t(n: Int): Fragment
Inherited from
FormattingFragments
def t: Fragment
Inherited from
FormattingFragments
def tag(tag: NamedTag): Fragment
Inherited from
TagDsl
def tag(names: String*): Fragment
Inherited from
TagDsl
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
def title(s: String)(using nothing: Int): SpecHeader
Inherited from
TitleDsl
def toResult(b: Boolean): Result
Inherited from
Results
def todo: Pending
Inherited from
StandardResults
def unbatched: Arguments
Returns

arguments for a specification where examples must be executed inside just one big batch

Inherited from
ArgumentsShortcuts
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 was(s: String): Arguments

shortcut to include only examples with some previous statuses

shortcut to include only examples with some previous statuses

Inherited from
ArgumentsShortcuts
def wontdo: Success
Inherited from
StandardResults
def xonly: Arguments

shortcut to print only failures and errors

shortcut to print only failures and errors

Inherited from
ArgumentsShortcuts
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

final lazy val DebugConsoleOutput: ConsoleOutput
Inherited from
Debug

The FragmentFactory has to be passed as an implicit in order to be inlined in macros

The FragmentFactory has to be passed as an implicit in order to be inlined in macros

Inherited from
S2StringContextCreation
lazy val args: ArgumentsNamespace
Inherited from
ArgumentsCreation
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 val ko: Result
Inherited from
ExpectedResults
lazy val ok: Result
Inherited from
ExpectedResults

Givens

Inherited givens

given downcastBeEqualTypedValueCheck[T, S >: T]: Conversion[BeEqualTypedValueCheck[T], ValueCheck[S]]

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

if an implicit execution environment is in scope, it can be used as an execution context

if an implicit execution environment is in scope, it can be used as an execution context

Inherited from
ImplicitExecutionContextFromExecutionEnv
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_Boolean_Result: Conversion[Boolean, Result]

implicit definition to accept any boolean value as a Result This avoids writing b must beTrue

implicit definition to accept any boolean value as a Result This avoids writing b must beTrue

Inherited from
Results
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

APPENDING TO ARGUMENTS

APPENDING TO ARGUMENTS

Inherited from
SpecStructureDsl

APPENDING TO A FRAGMENT

APPENDING TO A FRAGMENT

Inherited from
SpecStructureDsl

APPENDING TO FRAGMENTS

APPENDING TO FRAGMENTS

Inherited from
SpecStructureDsl

APPENDING TO A SPEC HEADER

APPENDING TO A SPEC HEADER

Inherited from
SpecStructureDsl

APPENDING TO A SPEC STRUCTURE

APPENDING TO A SPEC STRUCTURE

Inherited from
SpecStructureDsl

APPENDING TO A STRING

APPENDING TO A STRING

Inherited from
SpecStructureDsl
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 (alias: String)
def ~(s: => SpecificationStructure, tooltip: String): Fragment
Inherited from
ReferenceDsl
Inherited from
ReferenceDsl
def ~(s: SpecStructure, tooltip: String): Fragment
Inherited from
ReferenceDsl
Inherited from
ReferenceDsl
extension (alias: String)
def ~/(s: => SpecificationStructure, tooltip: String): Fragment
Inherited from
ReferenceDsl
def ~/(s: SpecStructure, tooltip: String): Fragment
Inherited from
ReferenceDsl
Inherited from
ReferenceDsl
extension (d: String)
def ![R](using not: NotGiven[NoBangExamples])(r: String => R)(using evidence$2: AsResult[R]): Fragment
Inherited from
ExampleDsl
def ![R](using not: NotGiven[NoBangExamples])(r: => R)(using evidence$1: AsResult[R]): Fragment
Inherited from
ExampleDsl
extension (d: String)
def !(using not: NotGiven[NoBangExamples])(execution: => Execution): Fragment
Inherited from
ExampleDsl
extension (d: String)
def ![R](using not: NotGiven[NoBangExamples])(r: Env => R)(using evidence$3: AsResult[R], p: ImplicitParam): Fragment
Inherited from
ExampleDsl
extension (description: String)
def <==>[T](using not: NotGiven[NoExpectationsDescription])(result: => T)(using evidence$2: AsResult[T]): Result
Inherited from
ExpectationsDescription
def ==>[T](using not: NotGiven[NoExpectationsDescription])(result: => T)(using evidence$1: AsResult[T]): Result
Inherited from
ExpectationsDescription
extension (f: T => S)
def ^^[T, S](m: Matcher[S]): Matcher[T]

this extension provides an inverted syntax to adapt matchers to make the adaptation more readable in some cases:

this extension provides an inverted syntax to adapt matchers to make the adaptation more readable in some cases:

  • def haveExtension(extension: =>String) = ((_:File).getPath) ^^ endWith(extension)
Inherited from
MatcherImplicits
extension (fragment: Fragment)
Inherited from
FragmentsDsl
extension (fragment: Fragment)
Inherited from
FragmentsDsl
extension (m: AdaptableMatcher[String])
def ignoreCase: 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
def ignoreSpace: 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
def trimmed: 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
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 (s: String)
def title(using not: NotGiven[NoTitleDsl]): SpecHeader
Inherited from
TitleDsl
extension (sc: StringContext)
inline def s2(using factory: FragmentFactory)(inline variables: Interpolated*): Fragments

String interpolation for specs2 fragments

String interpolation for specs2 fragments

Inherited from
S2StringContextCreation
extension (t: => T)
def pendingUntilFixed[T](using not: NotGiven[NoPendingUntilFixed])(m: String)(using evidence$3: AsExecution[T]): Execution
Returns

Pending unless the result is a success

Inherited from
PendingUntilFixed
def pendingUntilFixed[T](using evidence$2: AsExecution[T], not: NotGiven[NoPendingUntilFixed]): Execution
Returns

Pending unless the result is a success

Inherited from
PendingUntilFixed
extension (t: => T)
def pp[T](using not: NotGiven[NoDebug], output: ConsoleOutput)(pre: String): T

print the object to the console with a small message before

print the object to the console with a small message before

Inherited from
Debug
def pp[T](using not: NotGiven[NoDebug], output: ConsoleOutput)(show: T => String)(using p: ImplicitParam): T

print the object to the console with a specific function and return it

print the object to the console with a specific function and return it

Inherited from
Debug
def pp[T](using not: NotGiven[NoDebug], output: ConsoleOutput)(condition: T => Boolean): T

print the object to the console and return it, if the condition is satisfied

print the object to the console and return it, if the condition is satisfied

Inherited from
Debug
def pp[T](using not: NotGiven[NoDebug], output: ConsoleOutput)(condition: Boolean): T

print the object to the console and return it, if the condition is satisfied

print the object to the console and return it, if the condition is satisfied

Inherited from
Debug
def pp[T](using not: NotGiven[NoDebug], output: ConsoleOutput): T

print the object to the console and return it

print the object to the console and return it

Inherited from
Debug
extension (t: => T)
def !==[T](using not: NotGiven[NoTypedEqual])(other: => T)(using evidence$2: Diffable[T]): Result

! equality matcher on Expectables

! equality matcher on Expectables

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

equality matcher on Expectables

equality matcher on Expectables

Inherited from
TypedEqual
extension (t1: T1)
def ^[T1, T2](t2: => T2)(using tss: ToSpecStructure[T1, T2]): SpecStructure
Inherited from
SpecStructureDsl
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 (tm: => T)
def must[T](using not: NotGiven[NoMustExpectations])(m: => Matcher[T]): Result
Inherited from
MustExpectations
extension (tm: Expectable[T])
def must[T](using not: NotGiven[NoMustExpectations])(m: => Matcher[T]): Result
Inherited from
MustExpectations
extension (value: => T)
def showAs[T](using not: NotGiven[NoValueDescription], show: T => String): Expectable[T]
Returns

an expectable with a function to show the element T

Inherited from
ExpectationsDescription
extension (value: => T)
def aka[T](using not: NotGiven[NoValueDescription])(alias: => String): Expectable[T]
Returns

an expectable with an alias description

Inherited from
ExpectationsDescription
def aka[T](using not: NotGiven[NoValueDescription]): Expectable[T]
Returns

an expectable with its toString method as an alias description this is useful to preserve the original value when the matcher using it is adapting the value

Inherited from
ExpectationsDescription
def as[T](using not: NotGiven[NoValueDescription])(alias: String => String): Expectable[T]
Returns

an expectable with an alias description, after the value string

Inherited from
ExpectationsDescription
def post[T](using not: NotGiven[NoValueDescription])(alias: => String): Expectable[T]
Returns

an expectable with an alias description, after the value string

Inherited from
ExpectationsDescription
def showAs[T](using not: NotGiven[NoValueDescription])(show: T => String, p: ImplicitParam): Expectable[T]
Returns

an expectable with a function to show the element T

Inherited from
ExpectationsDescription
extension (value: Int)
def significantFigure: SignificantFigures

implicit definition to create significant figures for the beCloseTo matcher

implicit definition to create significant figures for the beCloseTo matcher

Inherited from
NumericMatchers
def significantFigures: SignificantFigures

implicit definition to create significant figures for the beCloseTo matcher

implicit definition to create significant figures for the beCloseTo matcher

Inherited from
NumericMatchers
extension (values: Iterable[T])
def atLeast[T, R](n: Int)(f: T => R)(using evidence$4: AsResult[R]): Result

Extend collections to check all their elements

Extend collections to check all their elements

Inherited from
MatcherImplicits
def atLeast[T, R](n: Times)(f: T => R)(using evidence$3: AsResult[R]): Result

Extend collections to check all their elements

Extend collections to check all their elements

Inherited from
MatcherImplicits
def atLeastOnce[T, R](f: T => R)(using evidence$1: AsResult[R]): Result

Extend collections to check all their elements

Extend collections to check all their elements

Inherited from
MatcherImplicits
def atMost[T, R](n: Int)(f: T => R)(using evidence$6: AsResult[R]): Result

Extend collections to check all their elements

Extend collections to check all their elements

Inherited from
MatcherImplicits
def atMost[T, R](n: Times)(f: T => R)(using evidence$5: AsResult[R]): Result

Extend collections to check all their elements

Extend collections to check all their elements

Inherited from
MatcherImplicits
def atMostOnce[T, R](f: T => R)(using evidence$2: AsResult[R]): Result

Extend collections to check all their elements

Extend collections to check all their elements

Inherited from
MatcherImplicits
def between[T, R](min: Int, max: Int)(f: T => R)(using evidence$8: AsResult[R]): Result

Extend collections to check all their elements

Extend collections to check all their elements

Inherited from
MatcherImplicits
def between[T, R](min: Times, max: Times)(f: T => R)(using evidence$7: AsResult[R]): Result

Extend collections to check all their elements

Extend collections to check all their elements

Inherited from
MatcherImplicits
def exactly[T, R](n: Int)(f: T => R)(using evidence$10: AsResult[R]): Result

Extend collections to check all their elements

Extend collections to check all their elements

Inherited from
MatcherImplicits
def exactly[T, R](n: Times)(f: T => R)(using evidence$9: AsResult[R]): Result

Extend collections to check all their elements

Extend collections to check all their elements

Inherited from
MatcherImplicits

Implicits

Inherited implicits

implicit inline def asExecutionIsInterpolated[R](inline r: => R)(using evidence$1: AsExecution[R], inline factory: FragmentFactory): Interpolated

create an example based on an execution

create an example based on an execution

Inherited from
S2StringContext
implicit inline def asResultIsInterpolated[R](inline r: => R)(using evidence$3: AsResult[R]): Interpolated
Inherited from
S2StringContext1
implicit def combineBoolean(b: => Boolean): ResultLogicalCombinator
Inherited from
ResultLogicalCombinators
implicit def combineResult(r: => Result): ResultLogicalCombinator
Inherited from
ResultLogicalCombinators
implicit inline def fragmentIsInterpolated(inline f: => Fragment): Interpolated
Inherited from
S2StringContext1
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
implicit def resultAsSpecStructure[R](r: => R)(using evidence$1: AsResult[R]): SpecStructure
Inherited from
SpecStructureDsl
implicit inline def stepParserIsInterpolatedFragment[R](f: StepParser[R])(using evidence$4: AsResult[R]): Interpolated
Inherited from
S2StringContext1
implicit def stringIsInterpolated(s: => String): Interpolated
Inherited from
S2StringContext
implicit inline def stringResultIsInterpolated[R](inline f: String => R)(using evidence$2: AsResult[R]): Interpolated
Inherited from
S2StringContext1
implicit def toArgProperty[T](t: => T)(using NotGiven[NoArgProperties], CanEqual[T, T]): ArgProperty[T]
Inherited from
ArgProperties