Struct kevlar::TestEvent

pub struct TestEvent { /* fields omitted */ }

A TestEvent is any event that you want to highlight during the test. Typically this will be a test failure but you might also want to capture other events also.

Methods

impl TestEvent

pub fn new(status: TestStatus) -> Self

Create a new TestEvent.

pub fn with_description(self, description: &str) -> Self

Supply a description to the TestEvent. Supports chaining.

Example:

TestEvent::new(TestStatus::Failed).with_description("Something went wrong")

pub fn with_artifact(self, artifact: TestArtifact) -> Self

Supply an artifact to the TestEvent. Supports chaining. You can add multiple artifacts by chaining this several times.

Example:

let event = TestEvent::new(TestStatus::Failed)
    .with_description("Something went wrong")
    .with_artifact(artifact1)
    .with_artifact(artifact2);

pub fn set_description(&mut self, description: &str)

Set the description of this event. This will override any existing description if one was already specified.

pub fn add_artifact(&mut self, artifact: TestArtifact)

Add an artifact to this event.

Trait Implementations

impl Display for TestEvent

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

Formats the value using the given formatter.

impl Debug for TestEvent

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

Formats the value using the given formatter.