Skip to main content

TestGuard

Struct TestGuard 

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

Zero-boilerplate test logger that auto-logs pass/fail on drop.

Unlike TestLogger, this guard automatically logs TEST PASS when dropped normally, or TEST FAIL when dropped during a panic. This eliminates the need to explicitly call .pass() or .fail().

§Usage

use rch_common::testing::TestGuard;

#[test]
fn test_example() {
    let _guard = TestGuard::new("test_example");
    // ... test logic ...
    // TEST PASS logged automatically when _guard drops
}

§Environment Variables

  • RCH_TEST_LOGGING=1: Enable logging (default: enabled in CI, disabled locally)
  • RCH_TEST_LOGGING=0: Disable logging

When disabled, the guard is a no-op for maximum performance.

Implementations§

Source§

impl TestGuard

Source

pub fn new(test_name: &str) -> Self

Create a new test guard.

If test logging is enabled (see environment variables), this creates a TestLogger and logs TEST START. Otherwise, it’s a no-op.

Source

pub fn log(&self, phase: TestPhase, message: impl Into<String>)

Log a message during test execution.

Source

pub fn log_with_data( &self, phase: TestPhase, message: impl Into<String>, data: Value, )

Log a message with structured data.

Trait Implementations§

Source§

impl Drop for TestGuard

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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<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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<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