Skip to main content

Reporter

Struct Reporter 

Source
pub struct Reporter { /* private fields */ }
Expand description

Fans run events out to every enabled sink.

Implementations§

Source§

impl Reporter

Source

pub fn new( level: Level, color: ColorMode, log_file: Option<&Path>, junit_file: Option<&Path>, trace_file: Option<&Path>, github_annotations: bool, ) -> Result<Self>

Creates a reporter with the given console settings and optional output files. Fails if a log/JUnit/trace file cannot be opened.

§Errors

Returns an io error when any configured output file cannot be created.

Source

pub fn emit(&self, event: &TestEvent) -> Result<()>

Emits one event to every enabled sink. The event is cloned and redacted (configured + runtime-observed secrets) before any sink sees it.

§Errors

Returns an io error when writing the NDJSON log file fails.

Source

pub fn add_redaction_secret(&self, value: &str)

Registers a literal value redacted from every report sink. Explicit extras always apply, regardless of length. Append-only: config- derived secrets registered later coexist with these.

Source

pub fn add_redaction_secrets(&self, values: impl IntoIterator<Item = String>)

Registers config-derived secrets (with the default minimum length) redacted from every report sink.

Source

pub fn info(&self, msg: impl AsRef<str>)

Writes a plain informational line if the current level allows it.

Source

pub fn debug(&self, msg: impl AsRef<str>)

Writes a debug line if -v (or higher) was passed.

Source

pub fn warn(&self, msg: impl AsRef<str>)

Writes a warning line; always shown unless -qq was passed.

Source

pub fn error(&self, msg: impl AsRef<str>)

Writes an error line; always shown.

Source

pub fn finish(&self) -> Result<()>

Flushes the NDJSON log and writes JUnit, trace, and GitHub summary files. Call once after the run finishes.

§Errors

Returns an io error when flushing the log or writing any report file fails.

Trait Implementations§

Source§

impl Default for Reporter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more