specs2-matcher
API
Generated with
specs2-matcher/org.specs2.matcher/ExpectationsDescription

ExpectationsDescription

org.specs2.matcher.ExpectationsDescription
See theExpectationsDescription companion object
trait ExpectationsDescription extends ExpectationsCreation

Attributes

Companion
object
Graph
Supertypes
trait ResultChecks
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Expectations
object Expectations.type
object ReturnsSyntax.type

Members list

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

Attributes

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

Attributes

Returns

an Expectable with a description function

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

Attributes

Returns

an Expectable with a description

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

Attributes

Returns

an Expectable

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

Attributes

Returns

an Expectable with a description function

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

Attributes

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

Attributes

Inherited from:
ResultChecks
protected def sandboxResult(r: => Result): Result

Attributes

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

Attributes

Inherited from:
MatchResultStackTrace
def theBlock(t: => Nothing): Expectable[Nothing]

Attributes

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

Attributes

Inherited from:
ExpectationsCreation

Extensions

Extensions

extension [T](description: String)(using not: NotGiven[NoExpectationsDescription])(using evidence$1: AsResult[T])
def ==>(result: => T): Result
extension [T](description: String)(using not: NotGiven[NoExpectationsDescription])(using evidence$2: AsResult[T])
def <==>(result: => T): Result
extension [T](value: => T)(using not: NotGiven[NoValueDescription])
infix def aka: Expectable[T]

Attributes

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

infix def aka(alias: => String): Expectable[T]

Attributes

Returns

an expectable with an alias description

infix def as(alias: String => String): Expectable[T]

Attributes

Returns

an expectable with an alias description, after the value string

infix def post(alias: => String): Expectable[T]

Attributes

Returns

an expectable with an alias description, after the value string

infix def showAs(show: T => String): Expectable[T]

Attributes

Returns

an expectable with a function to show the element T

extension [T](value: => T)(using not: NotGiven[NoValueDescription], show: T => String)
infix def showAs: Expectable[T]

Attributes

Returns

an expectable with a function to show the element T

Generated with