Skip to main content

DownloadCache

yt_dlp::cache::stores::files

Struct DownloadCache 

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

Download file cache manager with tiered L1 (Moka) + L2 (persistent) lookup.

On get_*: L1 → miss → L2 → backfill L1. On put_*: write to both layers.

Implementations§

Source§

impl DownloadCache

Source

pub async fn new(config: &CacheConfig, ttl: Option<u64>) -> Result<Self>

Create a new DownloadCache with default TTL.

§Arguments
  • config - The cache configuration specifying directories, TTLs, and backend settings.
  • ttl - Time-to-live for cache entries in seconds (optional).
§Returns

A new DownloadCache instance with default TTL (7 days).

§Errors

Returns an error if the backend initialization fails or the backend is ambiguous.

Source

pub async fn get_by_hash( &self, hash: &str, ) -> Result<Option<(CachedFile, PathBuf)>>

Retrieve a file by its content hash.

§Arguments
  • hash - The SHA-256 hash of the file content.
§Returns

The cached file metadata and its path, or None if not found.

§Errors

Returns an error if the underlying cache backend fails.

Source

pub async fn get_by_video_and_format( &self, video_id: &str, format_id: &str, ) -> Result<Option<(CachedFile, PathBuf)>>

Retrieve a file by video ID and format ID.

§Arguments
  • video_id - The video identifier.
  • format_id - The format identifier.
§Returns

The cached file metadata and its path, or None if not found.

§Errors

Returns an error if the underlying cache backend fails.

Source

pub async fn get_by_video_and_preferences( &self, video_id: &str, preferences: &FormatPreferences, ) -> Result<Option<(CachedFile, PathBuf)>>

Retrieve a file by video ID and quality/codec preferences.

§Arguments
  • video_id - The video identifier.
  • preferences - The format preferences to match against.
§Returns

The cached file metadata and its path, or None if no match.

§Errors

Returns an error if the underlying cache backend fails.

Source

pub async fn get_thumbnail_by_video_id( &self, video_id: &str, ) -> Result<Option<(CachedThumbnail, PathBuf)>>

Retrieve a thumbnail by video ID.

§Arguments
  • video_id - The video identifier.
§Returns

The cached thumbnail metadata and its path, or None if not found.

§Errors

Returns an error if the underlying cache backend fails.

Source

pub async fn get_subtitle_by_language( &self, video_id: &str, language: &str, ) -> Result<Option<(CachedFile, PathBuf)>>

Retrieve a subtitle by video ID and language code.

§Arguments
  • video_id - The video identifier.
  • language - The language code (e.g., “en”, “es”).
§Returns

The cached subtitle file metadata and its path, or None if not found.

§Errors

Returns an error if the underlying cache backend fails.

Source

pub async fn put_file( &self, source_path: &Path, filename: impl Into<String>, video_id: Option<String>, format: Option<&Format>, ) -> Result<PathBuf>

Store a file in the cache (both layers).

§Arguments
  • source_path - Path to the source file.
  • filename - Display name for the cached file.
  • video_id - Optional video ID association.
  • format - Optional format metadata to store alongside the file.
§Errors

Returns an error if the file cannot be hashed or stored.

Source

pub async fn put_file_with_preferences( &self, source_path: &Path, filename: impl Into<String>, video_id: Option<String>, format: Option<&Format>, preferences: &FormatPreferences, ) -> Result<PathBuf>

Store a file in the cache with quality/codec preferences (both layers).

§Arguments
  • source_path - Path to the source file.
  • filename - Display name for the cached file.
  • video_id - Optional video ID association.
  • format - Optional format metadata.
  • preferences - The format preferences used for selection.
§Errors

Returns an error if the file cannot be hashed or stored.

Source

pub async fn put_thumbnail( &self, source_path: &Path, filename: impl Into<String>, video_id: String, ) -> Result<PathBuf>

Store a thumbnail in the cache (both layers).

§Arguments
  • source_path - Path to the source thumbnail file.
  • filename - Display name for the cached thumbnail.
  • video_id - The video ID associated with this thumbnail.
§Errors

Returns an error if the thumbnail cannot be stored.

Source

pub async fn put_subtitle_file( &self, source_path: &Path, filename: impl Into<String>, video_id: String, language_code: String, ) -> Result<PathBuf>

Store a subtitle file in the cache (both layers).

§Arguments
  • source_path - Path to the source subtitle file.
  • filename - Display name for the cached subtitle.
  • video_id - The video ID associated with this subtitle.
  • language_code - The language code (e.g., “en”, “es”).
§Errors

Returns an error if the subtitle cannot be stored.

Source

pub async fn remove(&self, id: &str) -> Result<()>

Remove a file from the cache (both layers).

§Arguments
  • id - The unique identifier of the cached file.
§Errors

Returns an error if the removal operation fails.

Source

pub async fn clean(&self) -> Result<()>

Clean expired entries (both layers).

§Errors

Returns an error if the cleanup operation fails.

Source

pub async fn calculate_file_hash(path: &Path) -> Result<String>

Calculate the SHA-256 hash of a file.

§Arguments
  • path - The path to the file to hash.
§Returns

A hex-encoded SHA-256 hash string.

§Errors

Returns an error if the file cannot be read.

Trait Implementations§

Source§

impl Debug for DownloadCache

Source§

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

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> Same for T

Source§

type Output = T

Should always be Self
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