munit
API
Generated with
munit/munit/Compare

Compare

munit.Compare
See theCompare companion object
trait Compare[A, B]

A type-class that is used to compare values in MUnit assertions.

By default, uses == and allows comparison between any two types as long they have a supertype/subtype relationship. For example:

  • Compare[T, T] OK
  • Compare[Some[Int], Option[Int]] OK, subtype
  • Compare[Option[Int], Some[Int]] OK, supertype
  • Compare[List[Int], collection.Seq[Int]] OK, subtype
  • Compare[List[Int], Vector[Int]] Error, requires upcast to Seq[Int]`

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def isEqual(obtained: A, expected: B): Boolean

Returns true if the values are equal according to the rules of this Compare[A, B] instance.

Returns true if the values are equal according to the rules of this Compare[A, B] instance.

The default implementation of this method uses ==.

Attributes

Concrete methods

def failEqualsComparison(obtained: A, expected: B, title: Any, assertions: Assertions)(implicit loc: Location, options: DiffOptions): Nothing

Deprecated methods

def failEqualsComparison(obtained: A, expected: B, title: Any, loc: Location, assertions: Assertions): Nothing

Throws an exception to fail this assertion when two values are not equal.

Throws an exception to fail this assertion when two values are not equal.

Override this method to customize the error message. For example, it may be helpful to generate an image/HTML file if you're comparing visual values. Anything is possible, use your imagination!

Attributes

Returns

should ideally throw a org.junit.ComparisonFailException in order to support the IntelliJ diff viewer.

Deprecated
[Since version 1.0.4] Use version with implicit Location
Generated with