Skip to main content

VideoExtractor

yt_dlp::extractor

Trait VideoExtractor 

Source 
pub trait VideoExtractor:
    Downcast
    + Send
    + Sync
    + Debug {
    // Required methods
    fn fetch_video<'life0, 'life1, 'async_trait>(
        &'life0 self,
        url: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<Video>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn fetch_playlist<'life0, 'life1, 'async_trait>(
        &'life0 self,
        url: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<Playlist>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn name(&self) -> ExtractorName;
    fn supports_url(&self, url: &str) -> bool;
}
Expand description

Core trait for video extractors.

This trait defines the common interface that all extractors must implement. Each extractor handles fetching video metadata and playlists from their respective platform.

Required Methods§

Source

fn fetch_video<'life0, 'life1, 'async_trait>( &'life0 self, url: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Video>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetch video metadata from a URL.

§Arguments
  • url - The video URL to fetch
§Returns

Video metadata including formats, title, duration, etc.

§Errors

Returns error if the URL is unsupported, geo-blocked, or requires authentication

Source

fn fetch_playlist<'life0, 'life1, 'async_trait>( &'life0 self, url: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Playlist>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetch playlist metadata from a URL.

§Arguments
  • url - The playlist URL to fetch
§Returns

Playlist metadata including entries and metadata

§Errors

Returns error if the URL is unsupported or invalid

Source

fn name(&self) -> ExtractorName

Get the name of this extractor.

Source

fn supports_url(&self, url: &str) -> bool

Check if this extractor supports the given URL pattern.

This is a fast, synchronous check based on URL patterns. Use fetch_video() for definitive validation.

Implementations§

Source§

impl dyn VideoExtractor

Source

pub fn is<__T: VideoExtractor>(&self) -> bool

Returns true if the trait object wraps an object of type __T.

Source

pub fn downcast<__T: VideoExtractor>( self: Box<Self>, ) -> Result<Box<__T>, Box<Self>>

Returns a boxed object from a boxed trait object if the underlying object is of type __T. Returns the original boxed trait if it isn’t.

Source

pub fn downcast_rc<__T: VideoExtractor>( self: Rc<Self>, ) -> Result<Rc<__T>, Rc<Self>>

Returns an Rc-ed object from an Rc-ed trait object if the underlying object is of type __T. Returns the original Rc-ed trait if it isn’t.

Source

pub fn downcast_ref<__T: VideoExtractor>(&self) -> Option<&__T>

Returns a reference to the object within the trait object if it is of type __T, or None if it isn’t.

Source

pub fn downcast_mut<__T: VideoExtractor>(&mut self) -> Option<&mut __T>

Returns a mutable reference to the object within the trait object if it is of type __T, or None if it isn’t.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§