MatchFailed

Singleton object that provides unapply method to extract failure message from MatchResult having matches property value of false.

class Object
trait Matchable
class Any

Value members

Concrete methods

def unapply(matchResult: MatchResult)(implicit prettifier: Prettifier): Option[String]

Extractor enabling patterns that match MatchResult having matches property value of false, extracting the contained failure message.

Extractor enabling patterns that match MatchResult having matches property value of false, extracting the contained failure message.

For example, you can use this extractor to get the failure message of a MatchResult like this:

matchResult match {
 case MatchFailed(failureMessage) => // do something with failureMessage
 case _ => // when matchResult.matches equal to true
}
Value parameters:
matchResult

the MatchResult to extract the failure message from.

Returns:

a Some wrapping the contained failure message if matchResult.matches is equal to true, else None.