Struct AssertionBuilder

pub struct AssertionBuilder<S> { /* private fields */ }

Configures and constructs an Assertion.

This builder uses a state pattern to ensure that the necessary fields are configured before a valid Assertion can be constructed. You may notice that some methods are only available once other methods have been called.

You must first define a span matcher, which defines how this assertion is matched to a given span, and then you must specify the assertion criteria itself, which defines the behavior of the span to assert for.

Once these are defined, an Assertion can be constructed by calling [finalize].

Implementations

impl AssertionBuilder<NoMatcher>

pub fn with_name<S>(self, name: S) -> AssertionBuilder<NoCriteria>

where S: Into<String>,

Sets the name of the span to match.

All span matchers, which includes [with_name], [with_target], [with_parent_name], and [with_span_field], are additive, which means a span must match all of them to match the assertion overall.

pub fn with_target<S>(self, target: S) -> AssertionBuilder<NoCriteria>

where S: Into<String>,

Sets the target of the span to match.

All span matchers, which includes [with_name], [with_target], [with_parent_name], and [with_span_field], are additive, which means a span must match all of them to match the assertion overall.

impl AssertionBuilder<NoCriteria>

pub fn with_name<S>(self, name: S) -> AssertionBuilder<NoCriteria>

where S: Into<String>,

Sets the name of the span to match.

All span matchers, which includes [with_name], [with_target], [with_parent_name], and [with_span_field], are additive, which means a span must match all of them to match the assertion overall.

pub fn with_target<S>(self, target: S) -> AssertionBuilder<NoCriteria>

where S: Into<String>,

Sets the target of the span to match.

All span matchers, which includes [with_name], [with_target], [with_parent_name], and [with_span_field], are additive, which means a span must match all of them to match the assertion overall.

pub fn with_parent_name<S>(self, name: S) -> AssertionBuilder<NoCriteria>

where S: Into<String>,

Sets the name of a parent span to match.

The span must have at least one parent span within its entire lineage that matches the given name.

All span matchers, which includes [with_name], [with_target], [with_parent_name], and [with_span_field], are additive, which means a span must match all of them to match the assertion overall.

pub fn with_span_field<S>(self, field: S) -> AssertionBuilder<NoCriteria>

where S: Into<String>,

Adds a field which the span must contain to match.

The field is matched by name.

All span matchers, which includes [with_name], [with_target], and [with_span_field], are additive, which means a span must match all of them to match the assertion overall.

pub fn was_created(self) -> AssertionBuilder<Constrained>

Asserts that a matching span was created at least once.

pub fn was_entered(self) -> AssertionBuilder<Constrained>

Asserts that a matching span was entered at least once.

pub fn was_exited(self) -> AssertionBuilder<Constrained>

Asserts that a matching span was exited at least once.

pub fn was_closed(self) -> AssertionBuilder<Constrained>

Asserts that a matching span was closed at least once.

pub fn was_not_created(self) -> AssertionBuilder<Constrained>

Asserts that a matching span was not created.

pub fn was_not_entered(self) -> AssertionBuilder<Constrained>

Asserts that a matching span was not entered.

pub fn was_not_exited(self) -> AssertionBuilder<Constrained>

Asserts that a matching span was not exited.

pub fn was_not_closed(self) -> AssertionBuilder<Constrained>

Asserts that a matching span was not closed.

pub fn was_created_exactly(self, n: usize) -> AssertionBuilder<Constrained>

Asserts that a matching span was created exactly n times.

pub fn was_entered_exactly(self, n: usize) -> AssertionBuilder<Constrained>

Asserts that a matching span was entered exactly n times.

pub fn was_exited_exactly(self, n: usize) -> AssertionBuilder<Constrained>

Asserts that a matching span was exited exactly n times.

pub fn was_closed_exactly(self, n: usize) -> AssertionBuilder<Constrained>

Asserts that a matching span was closed exactly n times.

pub fn was_created_at_least(self, n: usize) -> AssertionBuilder<Constrained>

Asserts that a matching span was created at least n times.

pub fn was_entered_at_least(self, n: usize) -> AssertionBuilder<Constrained>

Asserts that a matching span was entered at least n times.

pub fn was_exited_at_least(self, n: usize) -> AssertionBuilder<Constrained>

Asserts that a matching span was exited at least n times.

pub fn was_closed_at_least(self, n: usize) -> AssertionBuilder<Constrained>

Asserts that a matching span was closed at least n times.

impl AssertionBuilder<Constrained>

pub fn was_created(self) -> Self

Asserts that a matching span was created at least once.

pub fn was_entered(self) -> Self

Asserts that a matching span was entered at least once.

pub fn was_exited(self) -> Self

Asserts that a matching span was exited at least once.

pub fn was_closed(self) -> Self

Asserts that a matching span was closed at least once.

pub fn was_not_created(self) -> Self

Asserts that a matching span was not created.

pub fn was_not_entered(self) -> Self

Asserts that a matching span was not entered.

pub fn was_not_exited(self) -> Self

Asserts that a matching span was not exited.

pub fn was_not_closed(self) -> Self

Asserts that a matching span was not closed.

pub fn was_created_exactly(self, n: usize) -> Self

Asserts that a matching span was created exactly n times.

pub fn was_entered_exactly(self, n: usize) -> Self

Asserts that a matching span was entered exactly n times.

pub fn was_exited_exactly(self, n: usize) -> Self

Asserts that a matching span was exited exactly n times.

pub fn was_closed_exactly(self, n: usize) -> Self

Asserts that a matching span was closed exactly n times.

pub fn was_created_at_least(self, n: usize) -> Self

Asserts that a matching span was created at least n times.

pub fn was_entered_at_least(self, n: usize) -> Self

Asserts that a matching span was entered at least n times.

pub fn was_exited_at_least(self, n: usize) -> Self

Asserts that a matching span was exited at least n times.

pub fn was_closed_at_least(self, n: usize) -> Self

Asserts that a matching span was closed at least n times.

pub fn finalize(self) -> Assertion

Creates the finalized Assertion.

Once finalized, the assertion is live and its state will be updated going forward.