Scalactic 3.3.0-alpha.1
API
Generated with
Scalactic 3.3.0-alpha.1/org.scalactic/Bool

Bool

org.scalactic.Bool
See theBool companion object
trait Bool

A trait that represent a rich-featured boolean value, which includes the following members:

  • a boolean value

  • methods useful for failure messages construction

  • logical expression methods that makes Bool composable

Bool is used by code generated from BooleanMacro (which AssertionsMacro and RequirementsMacro uses), it needs to be public so that the generated code can be compiled. It is expected that ScalaTest users would ever need to use Bool directly.

Attributes

Companion
object
Source
Bool.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def failureMessageArgs: IndexedSeq[Any]

Arguments to construct final failure message with raw message returned from rawFailureMessage.

Arguments to construct final failure message with raw message returned from rawFailureMessage.

Attributes

Source
Bool.scala
def midSentenceFailureMessageArgs: IndexedSeq[Any]

Arguments to construct final mid sentence failure message with raw message returned from rawMidSentenceFailureMessage.

Arguments to construct final mid sentence failure message with raw message returned from rawMidSentenceFailureMessage.

Attributes

Source
Bool.scala
def midSentenceNegatedFailureMessageArgs: IndexedSeq[Any]

Arguments to construct final negated mid sentence failure message with raw message returned from rawMidSentenceNegatedFailureMessage.

Arguments to construct final negated mid sentence failure message with raw message returned from rawMidSentenceNegatedFailureMessage.

Attributes

Source
Bool.scala
def negatedFailureMessageArgs: IndexedSeq[Any]

Arguments to construct final negated failure message with raw message returned from rawNegatedFailureMessage.

Arguments to construct final negated failure message with raw message returned from rawNegatedFailureMessage.

Attributes

Source
Bool.scala
def rawFailureMessage: String

raw message to report a failure

raw message to report a failure

Attributes

Source
Bool.scala
def rawMidSentenceFailureMessage: String

raw mid sentence message to report a failure

raw mid sentence message to report a failure

Attributes

Source
Bool.scala
def rawMidSentenceNegatedFailureMessage: String

raw mid sentence message with a meaning opposite to that of the failure message

raw mid sentence message with a meaning opposite to that of the failure message

Attributes

Source
Bool.scala
def rawNegatedFailureMessage: String

raw message with a meaning opposite to that of the failure message

raw message with a meaning opposite to that of the failure message

Attributes

Source
Bool.scala
def value: Boolean

the Boolean value of this Bool

the Boolean value of this Bool

Attributes

Source
Bool.scala

Concrete methods

def &(bool: => Bool): Bool

Logical and this Bool with another Bool

Logical and this Bool with another Bool

Value parameters

bool

another Bool

Attributes

Returns

a Bool that represents the result of logical and

Source
Bool.scala
def &&(bool: => Bool): Bool

Logical and this Bool with another Bool

Logical and this Bool with another Bool

Value parameters

bool

another Bool

Attributes

Returns

a Bool that represents the result of logical and

Source
Bool.scala
def failureMessage: String

Construct and return failure message, by applying arguments returned from failureMessageArgs to raw message returned from rawFailureMessage

Construct and return failure message, by applying arguments returned from failureMessageArgs to raw message returned from rawFailureMessage

Attributes

Source
Bool.scala
def midSentenceFailureMessage: String

Construct and return mid sentence failure message, by applying arguments returned from midSentenceFailureMessageArgs to raw message returned from rawMidSentenceFailureMessage

Construct and return mid sentence failure message, by applying arguments returned from midSentenceFailureMessageArgs to raw message returned from rawMidSentenceFailureMessage

Attributes

Source
Bool.scala
def midSentenceNegatedFailureMessage: String

Construct and return mid sentence negated failure message, by applying arguments returned from midSentenceNegatedFailureMessageArgs to raw message returned from rawMidSentenceNegatedFailureMessage

Construct and return mid sentence negated failure message, by applying arguments returned from midSentenceNegatedFailureMessageArgs to raw message returned from rawMidSentenceNegatedFailureMessage

Attributes

Source
Bool.scala
def negatedFailureMessage: String

Construct and return negated failure message, by applying arguments returned from negatedFailureMessageArgs to raw message returned from rawNegatedFailureMessage

Construct and return negated failure message, by applying arguments returned from negatedFailureMessageArgs to raw message returned from rawNegatedFailureMessage

Attributes

Source
Bool.scala
def unary_!: Bool

Negate this Bool

Negate this Bool

Attributes

Returns

a Bool that represents the result of negating the original Bool

Source
Bool.scala
def |(bool: => Bool): Bool

Logical or this Bool with another Bool

Logical or this Bool with another Bool

Value parameters

bool

another Bool

Attributes

Returns

a Bool that represents the result of logical or

Source
Bool.scala
def ||(bool: => Bool): Bool

Logical or this Bool with another Bool

Logical or this Bool with another Bool

Value parameters

bool

another Bool

Attributes

Returns

a Bool that represents the result of logical or

Source
Bool.scala

Abstract fields

val prettifier: Prettifier

Attributes

Source
Bool.scala

Concrete fields

lazy val analysis: IndexedSeq[String]

Attributes

Source
Bool.scala
Generated with