Struct SnapshotRequestor

pub struct SnapshotRequestor<T> { /* private fields */ }

Replays an RPC response to a request if it is found in the snapshot YAML file. If no such request has been seen before, it captures the new request/response pair obtained from the inner HttpPostRequestor and stores it into the snapshot file.

This is useful for snapshot testing only and should NOT be used in production.

Implementations

impl<T> SnapshotRequestor<T>

pub fn new(inner: T, snapshot_file: &str) -> Self

Creates a new instance by wrapping an existing HttpPostRequestor and capturing the request/response pairs.

The constructor does not load any snapshot entries from the snapshot_file. The SnapshotRequestor::load method must be used after construction to do that.

pub fn snapshot_path(&self) -> &str

Gets the path to the snapshot disk file.

pub fn clear(&self)

Clears all entries from the snapshot in memory. The snapshot file is not changed.

pub async fn try_load(&mut self, fail_on_miss: bool) -> Result<(), Error>

Clears all entries and loads them from the snapshot file. If fail_on_miss is set and the data is successfully loaded, all later requests that miss the loaded snapshot will result in HTTP error 404.

pub async fn load(self, fail_on_miss: bool) -> Self

Similar as SnapshotRequestor::try_load, except that no entries are cleared if the load fails.

This method consumes and returns self for easier call chaining.

pub fn with_aggresive_save(self) -> Self

Forces saving to disk on each newly inserted entry.

Use this only when the expected number of entries in the snapshot is small.

pub fn with_ignore_snapshot(self, ignore_snapshot: bool) -> Self

If set, the snapshot data will be ignored and resolution will always be done with the inner requestor.

This will inhibit any attempts to load or save snapshot data.

pub fn save(&self) -> Result<(), Error>

Save the currently cached entries to the snapshot file on disk.

Note that this method is automatically called on Drop, so usually it is unnecessary to call it explicitly.

Trait Implementations

impl<T: Clone> Clone for SnapshotRequestor<T>

fn clone(&self) -> SnapshotRequestor<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SnapshotRequestor<T>

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

Formats the value using the given formatter.

impl<T> Drop for SnapshotRequestor<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<R: HttpPostRequestor> HttpPostRequestor for &SnapshotRequestor<R>

fn http_post<'life0, 'life1, 'async_trait, T>( &'life0 self, url: &'life1 str, data: T, ) -> Pin<Box<dyn Future<Output = Result<Box<[u8]>, HttpRequestError>> + Send + 'async_trait>>

where T: Serialize + Send + Sync + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Performs HTTP POST of JSON data to the given URL and gets the JSON response.

impl<R: HttpPostRequestor> HttpPostRequestor for SnapshotRequestor<R>

fn http_post<'life0, 'life1, 'async_trait, T>( &'life0 self, url: &'life1 str, data: T, ) -> Pin<Box<dyn Future<Output = Result<Box<[u8]>, HttpRequestError>> + Send + 'async_trait>>

where T: Serialize + Send + Sync + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Performs HTTP POST of JSON data to the given URL and gets the JSON response.