Struct component_events::matcher::EventMatcher

pub struct EventMatcher {
    pub event_type: Option<EventTypeMatcher>,
    pub target_monikers: Option<MonikerMatcher>,
    pub capability_name: Option<CapabilityNameMatcher>,
    pub exit_status: Option<ExitStatusMatcher>,
    pub event_is_ok: Option<EventIsOkMatcher>,
}

Fields

event_type: Option<EventTypeMatcher>

target_monikers: Option<MonikerMatcher>

capability_name: Option<CapabilityNameMatcher>

exit_status: Option<ExitStatusMatcher>

event_is_ok: Option<EventIsOkMatcher>

Implementations

impl EventMatcher

pub fn ok() -> Self

pub fn err() -> Self

pub fn type(self, event_type: EventType) -> Self

pub fn moniker(self, moniker: impl Into<String>) -> Self

The expected target moniker. Will panic if the moniker is invalid.

pub fn monikers<I, S>(self, monikers: I) -> Self

where S: AsRef<str>, I: IntoIterator<Item = S>,

The expected target monikers. Will panic if any moniker is invalid.

pub fn moniker_regex(self, moniker: impl Into<String>) -> Self

The expected target moniker as a regular expression. If the exact moniker is known, use the moniker method instead.

pub fn monikers_regex<I, S>(self, monikers: I) -> Self

where S: AsRef<str>, I: IntoIterator<Item = S>,

The expected target monikers as regular expressions. This will match against regular expression in the iterator provided. If the exact monikers are known, use the monikers method instead.

pub fn capability_name(self, capability_name: impl Into<String>) -> Self

The expected capability name.

pub fn stop(self, exit_status: Option<ExitStatusMatcher>) -> Self

The expected exit status. Only applies to the Stop event.

pub async fn expect_match<T: Event>( &mut self, event_stream: &mut EventStream ) -> T

Expects the next event to match the provided EventMatcher. Returns the casted type if successful and an error otherwise.

pub async fn wait<T: Event>( self, event_stream: &mut EventStream ) -> Result<T, Error>

Waits for an event matching the matcher. Implicitly resumes all other events. Returns the casted type if successful and an error otherwise.

pub fn matches(&self, other: &EventDescriptor) -> Result<(), EventMatcherError>

Trait Implementations

impl Clone for EventMatcher

fn clone(&self) -> EventMatcher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventMatcher

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EventMatcher

fn default() -> EventMatcher

Returns the “default value” for a type.