Struct CacheConfig 

pub struct CacheConfig {
    pub cache_dir: PathBuf,
    pub redis_url: Option<String>,
    pub video_ttl: Option<u64>,
    pub playlist_ttl: Option<u64>,
    pub download_ttl: Option<u64>,
    pub persistent_backend: Option<PersistentBackendKind>,
}

Configuration for the tiered cache system.

Uses TypedBuilder for ergonomic construction with sensible defaults.

Examples

use std::path::PathBuf;

use yt_dlp::cache::CacheConfig;

let config = CacheConfig::builder()
    .cache_dir(PathBuf::from("cache"))
    .build();

Fields

cache_dir: PathBuf

Directory where cache data will be stored.

redis_url: Option<String>

Connection URL for Redis backend (e.g. “redis://127.0.0.1/”). Only used when cache-redis feature is enabled.

video_ttl: Option<u64>

Time-to-live for video cache entries in seconds. Default: 24 hours (86400 seconds).

playlist_ttl: Option<u64>

Time-to-live for playlist cache entries in seconds. Default: 6 hours (21600 seconds).

download_ttl: Option<u64>

Time-to-live for download/file cache entries in seconds. Default: 7 days (604800 seconds).

persistent_backend: Option<PersistentBackendKind>

Which persistent backend to activate at runtime.

Leave as None when exactly one persistent feature is compiled in (it is deduced automatically). Must be set explicitly when several persistent features (cache-json, cache-redb, cache-redis) are compiled in simultaneously.

Implementations

impl CacheConfig

pub fn builder() -> CacheConfigBuilder<((), (), (), (), (), ())>

Create a builder for building CacheConfig. On the builder, call .cache_dir(...), .redis_url(...)(optional), .video_ttl(...)(optional), .playlist_ttl(...)(optional), .download_ttl(...)(optional), .persistent_backend(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CacheConfig.

Trait Implementations

impl Clone for CacheConfig

fn clone(&self) -> CacheConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheConfig

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

Formats the value using the given formatter.

impl Display for CacheConfig

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

Formats the value using the given formatter.