Struct component_events::sequence::EventSequence

pub struct EventSequence { /* private fields */ }

Implementations

impl EventSequence

pub fn new() -> Self

pub fn then(self, matcher: EventMatcher) -> Self

pub fn all_of(self, events: Vec<EventMatcher>, ordering: Ordering) -> Self

Adds a group of matchers to verify all following events in the sequence match with the given ordering.

The sequence will fail to match if contains events that don’t match the group.

pub fn has_subset(self, events: Vec<EventMatcher>, ordering: Ordering) -> Self

Adds a group of matchers to verify that the sequence contains a subset of events that match with the given ordering.

Events in the sequence that don’t match will be ignored. Subsequent matchers outside of this group will not be able to match against ignored events.

pub async fn expect(self, event_stream: EventStream) -> Result<(), Error>

Verify that the events in this sequence are received from the provided EventStream.

pub async fn expect_and_giveback( self, event_stream: EventStream ) -> Result<EventStream, Error>

Verify that the events in this sequence are received from the provided EventStream, and gives back the event stream on success.

pub fn is_empty(&self) -> bool

pub fn event_names(&self) -> Result<Vec<String>, Error>

pub fn next(&mut self, event: &EventDescriptor) -> Result<(), Error>

Tests an EventDescriptor and against the first EventGroup.

If an EventGroup has been entirely consumed (no further EventMatchers to match against) then the EventGroup is dropped.

Returns an error if the EventSequence have not been entirely consumed, and the incoming EventDescriptor does not match the first sequence.

Returns Ok(true) if there is a positive match. Returns Ok(false) if the EventSequence is empty.

Trait Implementations

impl Clone for EventSequence

fn clone(&self) -> EventSequence

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.