Skip to main content

Spy

Struct Spy 

Source
pub struct Spy<T: Clone> { /* private fields */ }
Expand description

Call recorder that carries a wrapped value alongside it.

§This does not intercept anything

Spy is a manual recorder, not a proxy. Wrapping a value does not make its methods observable: Spy::inner hands back the value untouched, and calls made through that reference go straight to it. Recording happens only where you call Spy::record yourself:

#[derive(Clone)]
struct Repo;
impl Repo {
    fn find(&self, id: u32) -> String { format!("user-{id}") }
}

let spy = Spy::new(Repo);

// The call is recorded because the test records it, not because `Spy` saw it.
spy.record("find");
let user = spy.inner().find(7);

assert_eq!(user, "user-7");
assert_eq!(spy.call_count(), 1);
assert!(spy.was_called("find"));

For automatic interception, implement the trait under test on a hand-written fake that records in each method - Spy is then useful as that fake’s storage.

Cloning a Spy shares the recording buffer, so a clone handed to production code records into the same log the test asserts on.

Implementations§

Source§

impl<T: Clone> Spy<T>

Source

pub fn new(inner: T) -> Self

Create a new spy wrapping a provider

Source

pub fn record(&self, method: &str)

Record a method call.

Call this yourself at each site you want observed; Spy cannot see calls made through Spy::inner.

Source

pub fn call_count(&self) -> usize

Get the number of recorded calls

Source

pub fn was_called(&self, method: &str) -> bool

Check if a method was recorded as called

Source

pub fn calls(&self) -> Vec<String>

Every recorded call, in order.

Source

pub fn clear(&self)

Drop every recorded call.

Source

pub fn inner(&self) -> &T

Get the wrapped provider.

Returned untouched - calls made through this reference are NOT recorded. See the type-level docs.

Trait Implementations§

Source§

impl<T: Clone + Clone> Clone for Spy<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Spy<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Spy<T>
where T: RefUnwindSafe,

§

impl<T> Send for Spy<T>
where T: Send,

§

impl<T> Sync for Spy<T>
where T: Sync,

§

impl<T> Unpin for Spy<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Spy<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Spy<T>
where T: UnwindSafe,

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> 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<R, D> DepsPresent<D> for R

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Injectable for T
where T: Send + Sync + 'static,

Source§

fn type_id_of() -> TypeId
where Self: Sized,

Returns the TypeId of this type (for internal use)
Source§

fn type_name_of() -> &'static str
where Self: Sized,

Returns the type name for debugging
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> Provider for T
where T: Injectable,

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

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<R, D> VerifyDeps<D> for R

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