Struct UrlCache 

pub struct UrlCache {
    pub base_directory: PathBuf,
    pub files: LazyLock<Mutex<HashMap<String, PathBufRef>>>,
    pub directories: LazyLock<Mutex<HashMap<String, PathBufRef>>>,
}

Cache for a UrlContext.

Fields

base_directory: PathBuf

Base directory.

files: LazyLock<Mutex<HashMap<String, PathBufRef>>>

Files owned by this cache.

directories: LazyLock<Mutex<HashMap<String, PathBufRef>>>

Directories owned by this cache.

Implementations

impl UrlCache

pub async fn file_from_async( &self, url: &UrlRef, prefix: &str, ) -> Result<(PathBufRef, bool), UrlError>

Available on crate feature async only.

Get a cache file from a URL.

If it already exists returns the path and true. Otherwise copies the URL to a generated path and returns it and false.

impl UrlCache

pub fn file_from( &self, url: &UrlRef, prefix: &str, ) -> Result<(PathBufRef, bool), UrlError>

Available on crate feature blocking only.

Get a cache file from a URL.

If it already exists returns the path and true. Otherwise copies the URL to a generated path and returns it and false.

impl UrlCache

pub fn new(base_directory: Option<PathBuf>) -> Self

Constructor.

pub fn default_base_directory() -> PathBuf

Default base directory.

pub fn reset(&self) -> Result<(), UrlError>

Resets the cache, deleting all owned files and directories.

pub fn file( &self, key: &str, prefix: &str, ) -> Result<(PathBufRef, bool), UrlError>

Get a cache file.

If it already exists returns the path and true. Otherwise generates a path and returns it and false.

pub fn directory( &self, key: &str, prefix: &str, ) -> Result<(PathBufRef, bool), UrlError>

Get a cache directory.

If it already exists returns the path and true. Otherwise creates it (create_dir_all) in a generated path and returns it and false.

Trait Implementations

impl Debug for UrlCache

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

Formats the value using the given formatter.

impl Drop for UrlCache

fn drop(&mut self)

Executes the destructor for this type.