scalatestCoreDotty
API
Generated with
scalatestCoreDotty/org.scalatest/Fact

Fact

org.scalatest.Fact
See theFact companion object
sealed abstract class Fact

An abstract class representing a Fact that can be evaluated as either is yes or no.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Binary_&
class Binary_&&
class Binary_|
class Binary_||
class Implies
class IsEqvTo
class Leaf
class Unary_!
class VacuousYes
Show all

Members list

Value members

Abstract methods

def modifyMessage(fun: Option[String] => Option[String]): Fact

Get a new instance of Fact with the messages modified using the passed fun function.

Get a new instance of Fact with the messages modified using the passed fun function.

Attributes

Concrete methods

final def &(rhs: Fact): Fact

Creates a new Fact that represents a logical AND between this Fact and the provided Fact.

Creates a new Fact that represents a logical AND between this Fact and the provided Fact.

Value parameters

rhs

The Fact to be combined with this Fact using a logical AND.

Attributes

Returns

A new Fact representing the logical AND between this Fact and the provided Fact.

final def &&(rhs: => Fact): Fact

Creates a new Fact that represents a logical AND between this Fact and the provided Fact.

Creates a new Fact that represents a logical AND between this Fact and the provided Fact.

Value parameters

rhs

The Fact to be combined with this Fact using a logical AND.

Attributes

Returns

A new Fact representing the logical AND between this Fact and the provided Fact.

def factDiagram(level: Int): String

Generates a fact diagram, which is a textual representation of the fact and its structure.

Generates a fact diagram, which is a textual representation of the fact and its structure.

Value parameters

level

The indentation level for formatting the diagram.

Attributes

Returns

The fact diagram as a string.

def factMessage: String

Construct failure message to report if a fact fails, using rawFactMessage, factMessageArgs and prettifier

Construct failure message to report if a fact fails, using rawFactMessage, factMessageArgs and prettifier

Attributes

Returns

failure message to report if a fact fails

final def implies(rhs: => Fact): Fact

Creates a new Fact that represents the implication (=>) between this Fact and the provided Fact.

Creates a new Fact that represents the implication (=>) between this Fact and the provided Fact.

Value parameters

rhs

The Fact representing the implication's consequent.

Attributes

Returns

A new Fact representing the implication between this Fact and the provided Fact.

final def isEqvTo(rhs: Fact): Fact

Creates a new Fact that represents the equivalence (eqv) between this Fact and the provided Fact.

Creates a new Fact that represents the equivalence (eqv) between this Fact and the provided Fact.

Value parameters

rhs

The Fact representing the other side of the equivalence.

Attributes

Returns

A new Fact representing the equivalence between this Fact and the provided Fact.

final def isNo: Boolean

Indicates whether the fact is a no.

Indicates whether the fact is a no.

Attributes

def midSentenceFactMessage: String

Construct failure message suitable for appearing mid-sentence, using rawMidSentenceFactMessage, midSentenceFactMessageArgs and prettifier

Construct failure message suitable for appearing mid-sentence, using rawMidSentenceFactMessage, midSentenceFactMessageArgs and prettifier

Attributes

Returns

failure message suitable for appearing mid-sentence

def midSentenceSimplifiedFactMessage: String

Construct simplified failure message suitable for appearing mid-sentence, using rawMidSentenceSimplifiedFactMessage, midSentenceSimplifiedFactMessageArgs and prettifier

Construct simplified failure message suitable for appearing mid-sentence, using rawMidSentenceSimplifiedFactMessage, midSentenceSimplifiedFactMessageArgs and prettifier

Attributes

Returns

simplified failure message suitable for appearing mid-sentence

def simplifiedFactMessage: String

Construct simplified failure message to report if a fact fails, using rawSimplifiedFactMessage, simplifiedFactMessageArgs, and prettifier

Construct simplified failure message to report if a fact fails, using rawSimplifiedFactMessage, simplifiedFactMessageArgs, and prettifier

Attributes

Returns

simplified failure message to report if a fact fails

final def stringPrefix: String

String prefix for this fact, return either "Yes", "VacuousYes" or "No".

String prefix for this fact, return either "Yes", "VacuousYes" or "No".

Attributes

final def toAssertion(implicit pos: Position): Assertion

Convert this fact to Assertion.

Convert this fact to Assertion.

Value parameters

pos

the related Position for this fact.

Attributes

Returns

Succeeded if this fact is a yes.

Throws
TestCanceledException

if this fact is a vacuous yes.

TestFailedException

if this fact is not yes or vacuous yes.

final def toBoolean: Boolean

Convert the fact to Boolean, same as the value returned by isYes.

Convert the fact to Boolean, same as the value returned by isYes.

Attributes

override def toString: String

Converts this Fact to its string representation.

Converts this Fact to its string representation.

Attributes

Returns

The string representation of this Fact.

Definition Classes
Any
def unary_!: Fact

Negates this Fact, creating a version with the opposite value.

Negates this Fact, creating a version with the opposite value.

Attributes

Returns

A version of this Fact with the opposite value.

final def |(rhs: Fact): Fact

Creates a new Fact that represents a logical OR between this Fact and the provided Fact.

Creates a new Fact that represents a logical OR between this Fact and the provided Fact.

Value parameters

rhs

The Fact to be combined with this Fact using a logical OR.

Attributes

Returns

A new Fact representing the logical OR between this Fact and the provided Fact.

final def ||(rhs: => Fact): Fact

Creates a new Fact that represents a logical OR between this Fact and the provided Fact.

Creates a new Fact that represents a logical OR between this Fact and the provided Fact.

Value parameters

rhs

The Fact to be combined with this Fact using a logical OR.

Attributes

Returns

A new Fact representing the logical OR between this Fact and the provided Fact.

Abstract fields

val factMessageArgs: IndexedSeq[Any]

Arguments used to format the rawFactMessage.

Arguments used to format the rawFactMessage.

Attributes

val isLeaf: Boolean

Indicates whether the fact is a leaf (terminal) node in a fact tree.

Indicates whether the fact is a leaf (terminal) node in a fact tree.

Attributes

val isVacuousYes: Boolean

Indicates whether the fact is a vacuous yes, which means true in a sense but without meaningful assertions.

Indicates whether the fact is a vacuous yes, which means true in a sense but without meaningful assertions.

Attributes

val isYes: Boolean

Indicates whether the fact is a yes.

Indicates whether the fact is a yes.

Attributes

val midSentenceFactMessageArgs: IndexedSeq[Any]

Arguments used to format the rawMidSentenceFactMessage.

Arguments used to format the rawMidSentenceFactMessage.

Attributes

val midSentenceSimplifiedFactMessageArgs: IndexedSeq[Any]

Arguments used to format the rawMidSentenceSimplifiedFactMessage.

Arguments used to format the rawMidSentenceSimplifiedFactMessage.

Attributes

val prettifier: Prettifier

A prettifier used to format the messages when constructing failure messages.

A prettifier used to format the messages when constructing failure messages.

Attributes

val rawFactMessage: String

The raw message representing the fact.

The raw message representing the fact.

Attributes

val rawMidSentenceFactMessage: String

The raw mid-sentence message representing the fact.

The raw mid-sentence message representing the fact.

Attributes

val rawMidSentenceSimplifiedFactMessage: String

The raw mid-sentence simplified message representing the fact.

The raw mid-sentence simplified message representing the fact.

Attributes

val rawSimplifiedFactMessage: String

The raw simplified message representing the fact.

The raw simplified message representing the fact.

Attributes

val simplifiedFactMessageArgs: IndexedSeq[Any]

Arguments used to format the rawSimplifiedFactMessage.

Arguments used to format the rawSimplifiedFactMessage.

Attributes

Concrete fields

val cause: Option[Throwable]

An optional cause Throwable associated with the fact.

An optional cause Throwable associated with the fact.

Attributes

Generated with