Struct sealrs::testkit::actors::test_probe::TestProbe

pub struct TestProbe { /* fields omitted */ }

Methods

impl TestProbe

pub fn new(system: TSafe<TestLocalActorSystem>, name: Option<&str>) -> TestProbe

Initialize new probe. This is internal construct, do not try use it directly

pub fn aref(&mut self) -> ActorRef

Return internal actor reference

pub fn set_timeout(&mut self, timeout: Duration)

Set default expects timeout

pub fn send(&mut self, target: &mut ActorRef, msg: Message)

Send message to some actor

pub fn reply(&mut self, msg: Message)

Reply to the last sender with specified message

pub fn expect_msg(
    &mut self,
    matcher: Box<dyn Fn(Message) -> bool + Send>
) -> Message

Expect a single message from an actor. Blocks called thread while message will be received or timeout was reached. Returns intercepted message instance.

Example

probe.expect_msg(type_matcher!(some_actor::SomeMsg));
let msg = probe.expect_msg(type_matcher!(some_actor::SomeMsgOther));

pub fn expect_msg_any_of(
    &mut self,
    matchers: Vec<Box<dyn Fn(Message) -> bool + Send>>
) -> Message

Expect an any message in the specified set from an actor. Blocks called thread while message will be received or timeout was reached. Returns intercepted messages list.

Example

probe.expect_msg_any_of(
    vec![
        type_matcher!(some_actor::SomeMsg0)),
        type_matcher!(some_actor::SomeMsg1)),
        type_matcher!(some_actor::SomeMsg2))
    ]
);

pub fn expect_msg_all_of(
    &mut self,
    matchers: Vec<Box<dyn Fn(Message) -> bool + Send>>
) -> Vec<Message>

Expect all messages in specified set from an actor. Order of messages is not not significant. Target message may be altered with some other messages. Test will passed, when all messages from the list, will be intercepted from input messages stream. Blocks called thread while message will be received or timeout was reached. Returns intercepted messages list.

Example

probe.expect_msg_all_of(
    vec![
        type_matcher!(some_actor::SomeMsg0)),
        type_matcher!(some_actor::SomeMsg1)),
        type_matcher!(some_actor::SomeMsg2))
    ]
);

pub fn expect_no_msg(&mut self, duration: Duration)

Expect than no one actor do not send message to this probe in specified time duration

Example

probe.expect_no_msg(Duration::from_secs(1));

pub fn expect_terminated(&mut self, target: &ActorRef)

Expect termination of the target. Probe must be watch it before cull this expector.

Example

 probe.watch(&target);
 // Some other code
 probe.expect_terminated(&target);

pub fn watch(&mut self, target: &ActorRef)

Subscribe probe fot watching events of target

pub fn get_last_sender(&self) -> MutexGuard<ActorRef>

Returns the sender of the last received message.

pub fn stop(&mut self)

Stops the probe inner actor

Trait Implementations

impl Drop for TestProbe

fn drop(&mut self)

Executes the destructor for this type.