ExpectationsDescription

Companion
object
class Object
trait Matchable
class Any

Value members

Inherited methods

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 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
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
protected def sandboxResult(r: => Result): Result
Returns

the result without any side-effects

Inherited from
ResultChecks
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 theBlock(t: => Nothing): Expectable[Nothing]
Inherited from
ExpectationsCreation
def theValue[T](t: => T): Expectable[T]
Inherited from
ExpectationsCreation

Extensions

Extensions

extension (description: String)
def <==>[T](using not: NotGiven[NoExpectationsDescription])(result: => T)(using evidence$2: AsResult[T]): Result
def ==>[T](using not: NotGiven[NoExpectationsDescription])(result: => T)(using evidence$1: AsResult[T]): Result
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

extension (value: => T)
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

def aka[T](using not: NotGiven[NoValueDescription])(alias: => String): Expectable[T]
Returns

an expectable with an alias description

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

an expectable with an alias description, after the value string

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

an expectable with an alias description, after the value string

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