Skip to main content

DiskCache

Struct DiskCache 

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

Disk-based response cache with configurable TTL.

Caches HTTP response text as JSON files keyed by a hash of the request URL, query parameters, and optional POST body. Expired entries are treated as cache misses and silently ignored.

§Atomic writes

Writes use a temporary file + rename pattern to prevent partial reads from concurrent access.

Implementations§

Source§

impl DiskCache

Source

pub fn new(cache_dir: PathBuf, ttl: Duration) -> Result<DiskCache, Error>

Create a cache storing entries in cache_dir with the given TTL.

Creates the directory (and parents) if it doesn’t exist.

Source

pub fn default_location(ttl: Duration) -> Result<DiskCache, Error>

Create a cache in the platform-standard cache directory.

  • Linux: ~/.cache/papers/requests
  • macOS: ~/Library/Caches/papers/requests
  • Windows: {FOLDERID_LocalAppData}/papers/requests

Returns Err if no cache directory can be determined or created.

Source

pub fn get( &self, url: &str, query: &[(&str, String)], body: Option<&str>, ) -> Option<String>

Look up a cached response.

Returns None on cache miss, expired entry, or any I/O / parse error.

Source

pub fn set( &self, url: &str, query: &[(&str, String)], body: Option<&str>, response: &str, )

Store a response in the cache.

Writes atomically via a .tmp file + rename. Errors are silently ignored — a failed cache write should never break a request.

Source

pub fn prune(&self)

Remove expired entries and leftover .tmp files from the cache directory.

Called automatically on construction. Errors on individual files are silently ignored.

Trait Implementations§

Source§

impl Clone for DiskCache

Source§

fn clone(&self) -> DiskCache

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 DiskCache

Source§

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

Formats the value using the given formatter. 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> 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.

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