FullReceiveMatcher

net.ruippeixotog.akka.testkit.specs2.api.package$.FullReceiveMatcher

Attributes

Graph
Supertypes
trait ReceiveMatcher[P, A]
trait Matcher[P]
class Object
trait Matchable
class Any
Known subtypes

Members list

Concise view

Value members

Abstract methods

def allOf(msgs: A*): SkippableReceiveMatcher[P, Seq[A]]

Checks that the probe received a sequence of messages, possibly unordered. The timeout is applied to the whole sequence and not per message (i.e. all the messages have to be received before the timeout duration).

Checks that the probe received a sequence of messages, possibly unordered. The timeout is applied to the whole sequence and not per message (i.e. all the messages have to be received before the timeout duration).

Attributes

msgs

the expected sequence of messages

Returns:

a new matcher that expects a probe to have received all the messages in msgs, possibly unordered.

def apply(msg: A): SkippableReceiveMatcher[P, A]

Checks that the received message is equal to the given value.

Checks that the received message is equal to the given value.

Attributes

msg

the expected message

Returns:

a new matcher that expects a probe to have received msg.

def like[R : AsResult](f: PartialFunction[A, R]): SkippableReceiveMatcher[P, A]

Checks that the received message satisfies a partial predicate or function applying further checks.

Checks that the received message satisfies a partial predicate or function applying further checks.

Attributes

f

the partial predicate or function applying further checks

Returns:

a new matcher that expects a probe to have received messages satisfying f.

def ofSubtype[B <: A : ClassTag](implicit evidence$1: ClassTag[B], ev: A <:< AnyRef): FullReceiveMatcher[P, B]

Constrains the received messages to be of a given subtype.

Constrains the received messages to be of a given subtype.

Attributes

B

the expected subtype of messages

Returns:

a new matcher that expects a probe to have received messages of type B.

def unwrap[B](f: A => B): FullReceiveMatcher[P, B]

Applies a function to the received messages before checks. Commonly used to unwrap data in envelope-like messages.

Applies a function to the received messages before checks. Commonly used to unwrap data in envelope-like messages.

Attributes

B

the return type of the function

f

the function to apply to messages

Returns:

a new matcher that applies f to messages before checking them.

def unwrapPf[B](f: PartialFunction[A, B]): FullReceiveMatcher[P, B]

Applies a partial function to the received messages before checks. Messages for which the function is undefined count as failures. Commonly used to unwrap data in envelope-like messages.

Applies a partial function to the received messages before checks. Messages for which the function is undefined count as failures. Commonly used to unwrap data in envelope-like messages.

Attributes

B

the return type of the function

f

the partial function to apply to messages

Returns:

a new matcher that applies f to messages before checking them.

def which[R : AsResult](f: A => R): SkippableReceiveMatcher[P, A]

Checks that the received message satisfies a predicate or a function applying further checks.

Checks that the received message satisfies a predicate or a function applying further checks.

Attributes

f

the predicate or function applying further checks

Returns:

a new matcher that expects a probe to have received messages satisfying f.

Inherited methods

def ^^[S](f: S => Expectable[P], dummy: Int): Matcher[S]

Adapt a matcher to another. ex: be_==("message") ^^ (_.getMessage aka "trimmed") can be applied to an exception

Adapt a matcher to another. ex: be_==("message") ^^ (_.getMessage aka "trimmed") can be applied to an exception

The dummy value is used to help to disambiguate with the overloaded ^^ function

Attributes

Inherited from:
Matcher
def ^^[S](f: S => P): Matcher[S]

Adapt a matcher to another. ex: be_==("message") ^^ (_.getMessage) can be applied to an exception

Adapt a matcher to another. ex: be_==("message") ^^ (_.getMessage) can be applied to an exception

Attributes

Inherited from:
Matcher

Skips non-matching messages until a matching one is received or a timeout occurs. Commonly used when the order of received messages cannot be guaranteed and the probe may receive other messages, like heartbeats.

Skips non-matching messages until a matching one is received or a timeout occurs. Commonly used when the order of received messages cannot be guaranteed and the probe may receive other messages, like heartbeats.

Attributes

Returns:

a new matcher that skips non-matching messages until a matching one is received or a timeout occurs.

Inherited from:
SkippableReceiveMatcher
def and[S <: P](m: => Matcher[S]): Matcher[S]

the logical and between 2 matchers

the logical and between 2 matchers

Attributes

See also:

MatchResult.and

Inherited from:
Matcher
def apply[S <: P](t: Expectable[S]): MatchResult[S]

apply this matcher to an Expectable

apply this matcher to an Expectable

Attributes

Returns:

a MatchResult describing the outcome of the match

Inherited from:
Matcher
def eventually(retries: Int, sleep: Int => Duration): Matcher[T]

Attributes

sleep

the function applied on the retry number (first is 1)

Returns:

a matcher that needs to eventually match, after a given number of retries and a sleep time

aResult mustEqual(expected).eventually(retries = 2, _ * 100.milliseconds)
Inherited from:
Matcher
def eventually(retries: Int, sleep: Duration): Matcher[T]

Attributes

Returns:

a matcher that needs to eventually match, after a given number of retries and a sleep time

Inherited from:
Matcher
def eventually: Matcher[T]

Attributes

Returns:

a matcher that needs to eventually match, after 40 retries and a sleep time of 100 milliseconds

Inherited from:
Matcher
def iff(b: Boolean): Matcher[T]

when the condition is true the matcher is applied, when it's false, the matcher must fail

when the condition is true the matcher is applied, when it's false, the matcher must fail

Attributes

Inherited from:
Matcher
def lazily: Matcher[() => T]

The lazily operator returns a Matcher which will match a function returning the expected value

The lazily operator returns a Matcher which will match a function returning the expected value

Attributes

Inherited from:
Matcher
def mute: Matcher[T]

Attributes

Returns:

a Matcher with no messages

Inherited from:
Matcher
def not: Matcher[T]

negate a Matcher

negate a Matcher

Attributes

See also:

MatchResult.not

Inherited from:
Matcher
def or[S <: P](m: => Matcher[S]): Matcher[S]

the logical or between 2 matchers

the logical or between 2 matchers

Attributes

See also:

MatchResult.or

Inherited from:
Matcher
def orPending(message: String => String): Matcher[T]

Attributes

Returns:

a Pending MatchResult if this matcher fails, modifying the failure message with a pending message.

Inherited from:
Matcher
def orPending(m: String): Matcher[T]

Attributes

Returns:

a Pending MatchResult if this matcher fails, prefixing the failure message with a pending message. If the pending message is empty, only the failure message is printed

Inherited from:
Matcher
def orPending: Matcher[T]

Attributes

Returns:

a Pending MatchResult if this matcher fails

Inherited from:
Matcher
def orSkip(message: String => String): Matcher[T]

Attributes

Returns:

a Skip MatchResult if this matcher fails, modifying the failure message with a skip message.

Inherited from:
Matcher
def orSkip(m: String): Matcher[T]

Attributes

Returns:

a Skip MatchResult if this matcher fails, prefixing the failure message with a skip message. If the skip message is empty, only the failure message is printed

Inherited from:
Matcher
def orSkip: Matcher[T]

Attributes

Returns:

a Skip MatchResult if this matcher fails

Inherited from:
Matcher
def setMessage(message: String): Matcher[T]

Attributes

Returns:

set a new failure message of a matcher

Inherited from:
Matcher
def test: T => Boolean

Attributes

Returns:

a test function corresponding to this matcher

Inherited from:
Matcher
def unless(b: Boolean, m: String): Matcher[T]

only apply this matcher if the condition is false

only apply this matcher if the condition is false

Attributes

Inherited from:
Matcher
def updateMessage(f: String => String): Matcher[T]

Attributes

Returns:

update the failure message of a matcher

Inherited from:
Matcher
def when(b: Boolean, m: String): Matcher[T]

only apply this matcher if the condition is true

only apply this matcher if the condition is true

Attributes

Inherited from:
Matcher