Trait Source 

pub trait Source:
    Send
    + Sync
    + 'static {
    // Required methods
    fn name(&self) -> &str;
    fn track<'life0, 'life1, 'async_trait>(
        &'life0 self,
        identifier: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<Track, Failure>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;

    // Provided methods
    fn search_prefix(&self) -> Option<&str> { ... }
    fn search<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _query: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Track>, Failure>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn matches_url(&self, _url: &str) -> bool { ... }
    fn load_url<'life0, 'life1, 'async_trait>(
        &'life0 self,
        url: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<LoadResult, Failure>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn playable(&self) -> Option<&dyn Playable> { ... }
    fn isrc_lookup(&self) -> Option<&dyn IsrcLookup> { ... }
    fn recommender(&self) -> Option<&dyn Recommender> { ... }
}

Resolves searches, links and identifiers to tracks.

Required Methods

fn name(&self) -> &str

Unique name, stored in Track::source ("soundcloud").

fn track<'life0, 'life1, 'async_trait>( &'life0 self, identifier: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Track, Failure>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetch one track by identifier.

Provided Methods

fn search_prefix(&self) -> Option<&str>

Search prefix without the colon ("scsearch"), if the source searches.

fn search<'life0, 'life1, 'async_trait>( &'life0 self, _query: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<Track>, Failure>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Plain-text search.

fn matches_url(&self, _url: &str) -> bool

Whether this source handles url.

fn load_url<'life0, 'life1, 'async_trait>( &'life0 self, url: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<LoadResult, Failure>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Resolve a link (track, playlist, album…).

fn playable(&self) -> Option<&dyn Playable>

The playback capability, if this source can stream audio.

fn isrc_lookup(&self) -> Option<&dyn IsrcLookup>

ISRC lookup capability, used to mirror metadata-only sources.

fn recommender(&self) -> Option<&dyn Recommender>

Recommendation capability (radio/autoplay).

Dyn Compatibility

This trait is dyn compatible.

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

Implementors