Skip to main content

CacheManager

Struct CacheManager 

Source
pub struct CacheManager {
    pub cache_dir: PathBuf,
    pub offline: bool,
    /* private fields */
}
Expand description

Downloads and caches MTGJSON data files from the CDN.

Checks Meta.json for version changes and re-downloads when stale. Individual files are downloaded lazily on first access.

Fields§

§cache_dir: PathBuf

Directory where cached files are stored.

§offline: bool

If true, never download from CDN (use cached files only).

Implementations§

Source§

impl CacheManager

Source

pub fn new( cache_dir: Option<PathBuf>, offline: bool, timeout: Duration, on_progress: Option<ProgressCallback>, ) -> Result<Self>

Create a new cache manager.

If cache_dir is None, uses the platform-appropriate default cache directory. Creates the cache directory if it does not exist.

Source

pub fn client(&mut self) -> &Client

Lazy HTTP client, created on first use.

Source

pub fn remote_version(&mut self) -> Result<Option<String>>

Fetch the current MTGJSON version from Meta.json on the CDN.

Returns the version string (e.g. "5.2.2+20240101"), or None if offline or the CDN is unreachable. Caches the result for subsequent calls.

Source

pub fn is_stale(&mut self) -> Result<bool>

Check if local cache is out of date compared to the CDN.

Returns true if there is no local cache or the CDN has a newer version. Returns false if up to date or if the CDN is unreachable.

Source

pub fn ensure_parquet(&mut self, view_name: &str) -> Result<PathBuf>

Ensure a parquet file is cached locally, downloading if needed.

§Arguments
  • view_name - Logical view name (e.g. "cards", "sets").
§Returns

Local filesystem path to the cached parquet file.

Source

pub fn ensure_json(&mut self, name: &str) -> Result<PathBuf>

Ensure a JSON file is cached locally, downloading if needed.

§Arguments
  • name - Logical file name (e.g. "meta", "all_prices_today").
§Returns

Local filesystem path to the cached JSON file.

Source

pub fn load_json(&mut self, name: &str) -> Result<Value>

Load and parse a JSON file (handles .gz transparently).

If the cached file is corrupt (truncated download, disk error), it is deleted automatically so the next call re-downloads a fresh copy.

Source

pub fn clear(&self) -> Result<()>

Remove all cached files and recreate the cache directory.

Source

pub fn close(&mut self)

Close the HTTP client, if open.

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