Trace

Struct Trace 

Source
pub struct Trace { /* private fields */ }
Available on crate feature tracing only.
Expand description

Decorator that enables tracing for tests.

§Examples

use test_casing::{decorate, decorators::Trace};

// Tracing output configuration. Allows to specify the default log directives
// (can be overridden by the `RUST_LOG` env var in the runtime), and to configure
// more concise or pretty output.
static TRACE: Trace = Trace::new("info,test_crate=trace").pretty();

#[decorate(TRACE)]
#[test]
fn some_test() {
    // Test logic...
    tracing::info!("logging event");
}

Implementations§

Source§

impl Trace

Source

pub const fn new(directives: &'static str) -> Self

Creates a decorator with the specified directives. The directives can be overridden by the RUST_LOG env variable in runtime.

Source

pub const fn pretty(self) -> Self

Enables pretty formatting for the tracing events.

Source

pub const fn global(self) -> Self

Sets up the tracing subscriber globally (vs the default thread-local setup). This is only beneficial for multithreaded tests, and may have undesired side effects.

Source

pub fn create_subscriber(self) -> impl Subscriber + for<'a> LookupSpan<'a>

Creates a subscriber based on the configured params. This is useful in order to reuse Trace logic in more complex decorators (e.g., ones that capture tracing spans / events).

Trait Implementations§

Source§

impl Clone for Trace

Source§

fn clone(&self) -> Trace

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Trace

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<R> DecorateTest<R> for Trace

Source§

fn decorate_and_test<F: TestFn<R>>(&'static self, test_fn: F) -> R

Decorates the provided test function and runs the test.
Source§

impl Copy for Trace

Auto Trait Implementations§

§

impl Freeze for Trace

§

impl RefUnwindSafe for Trace

§

impl Send for Trace

§

impl Sync for Trace

§

impl Unpin for Trace

§

impl UnwindSafe for Trace

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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