Struct ytmapi_rs::query::SearchQuery

pub struct SearchQuery<'a, S: SearchType> { /* private fields */ }

An API search query.

Implementations

impl<'a> SearchQuery<'a, BasicSearch>

pub fn new<Q: Into<Cow<'a, str>>>(q: Q) -> SearchQuery<'a, BasicSearch>

impl<'a, S: SearchType> SearchQuery<'a, S>

pub fn with_spelling_mode(self, spelling_mode: SpellingMode) -> Self

Set spelling mode.

pub fn with_query<Q: Into<Cow<'a, str>>>(self, query: Q) -> Self

Chnage the set query.

impl<'a> SearchQuery<'a, BasicSearch>

pub fn with_filter<F: FilteredSearchType>( self, filter: F, ) -> SearchQuery<'a, FilteredSearch<F>>

Apply a filter to the search. May change type of results returned.

pub fn uploads(self) -> SearchQuery<'a, UploadSearch>

Search only uploads.

pub fn library(self) -> SearchQuery<'a, LibrarySearch>

Search only library.

impl<'a, F: FilteredSearchType> SearchQuery<'a, FilteredSearch<F>>

pub fn with_filter<F2: FilteredSearchType>( self, filter: F2, ) -> SearchQuery<'a, FilteredSearch<F2>>

Apply a filter to the search. May change type of results returned.

pub fn unfiltered(self) -> SearchQuery<'a, BasicSearch>

Remove filter from the query.

impl<'a> SearchQuery<'a, UploadSearch>

pub fn with_scope_public(self) -> SearchQuery<'a, BasicSearch>

Change scope to search generally instead of Uploads.

impl<'a> SearchQuery<'a, LibrarySearch>

pub fn with_scope_public(self) -> SearchQuery<'a, BasicSearch>

Change scope to search generally instead of Library.

Trait Implementations

impl<'a, S: Clone + SearchType> Clone for SearchQuery<'a, S>

fn clone(&self) -> SearchQuery<'a, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, S: Debug + SearchType> Debug for SearchQuery<'a, S>

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

Formats the value using the given formatter.

impl<'a, Q: Into<Cow<'a, str>>, S: SearchType> From<Q> for SearchQuery<'a, S>

fn from(value: Q) -> SearchQuery<'a, S>

Converts to this type from the input type.

impl<'a> ParseFrom<SearchQuery<'a, FilteredSearch<AlbumsFilter>>> for Vec<SearchResultAlbum>

fn parse_from( p: ProcessedResult<'_, SearchQuery<'a, FilteredSearch<AlbumsFilter>>>, ) -> Result<Self>

impl<'a> ParseFrom<SearchQuery<'a, FilteredSearch<ArtistsFilter>>> for Vec<SearchResultArtist>

fn parse_from( p: ProcessedResult<'_, SearchQuery<'a, FilteredSearch<ArtistsFilter>>>, ) -> Result<Self>

impl<'a> ParseFrom<SearchQuery<'a, FilteredSearch<CommunityPlaylistsFilter>>> for Vec<SearchResultPlaylist>

fn parse_from( p: ProcessedResult<'_, SearchQuery<'a, FilteredSearch<CommunityPlaylistsFilter>>>, ) -> Result<Self>

impl<'a> ParseFrom<SearchQuery<'a, FilteredSearch<EpisodesFilter>>> for Vec<SearchResultEpisode>

fn parse_from( p: ProcessedResult<'_, SearchQuery<'a, FilteredSearch<EpisodesFilter>>>, ) -> Result<Self>

impl<'a> ParseFrom<SearchQuery<'a, FilteredSearch<FeaturedPlaylistsFilter>>> for Vec<SearchResultFeaturedPlaylist>

fn parse_from( p: ProcessedResult<'_, SearchQuery<'a, FilteredSearch<FeaturedPlaylistsFilter>>>, ) -> Result<Self>

impl<'a> ParseFrom<SearchQuery<'a, FilteredSearch<PlaylistsFilter>>> for Vec<SearchResultPlaylist>

fn parse_from( p: ProcessedResult<'_, SearchQuery<'a, FilteredSearch<PlaylistsFilter>>>, ) -> Result<Self>

impl<'a> ParseFrom<SearchQuery<'a, FilteredSearch<PodcastsFilter>>> for Vec<SearchResultPodcast>

fn parse_from( p: ProcessedResult<'_, SearchQuery<'a, FilteredSearch<PodcastsFilter>>>, ) -> Result<Self>

impl<'a> ParseFrom<SearchQuery<'a, FilteredSearch<ProfilesFilter>>> for Vec<SearchResultProfile>

fn parse_from( p: ProcessedResult<'_, SearchQuery<'a, FilteredSearch<ProfilesFilter>>>, ) -> Result<Self>

impl<'a> ParseFrom<SearchQuery<'a, FilteredSearch<SongsFilter>>> for Vec<SearchResultSong>

fn parse_from( p: ProcessedResult<'_, SearchQuery<'a, FilteredSearch<SongsFilter>>>, ) -> Result<Self>

impl<'a> ParseFrom<SearchQuery<'a, FilteredSearch<VideosFilter>>> for Vec<SearchResultVideo>

fn parse_from( p: ProcessedResult<'_, SearchQuery<'a, FilteredSearch<VideosFilter>>>, ) -> Result<Self>

impl<'a, S: UnfilteredSearchType> ParseFrom<SearchQuery<'a, S>> for SearchResults

fn parse_from(p: ProcessedResult<'_, SearchQuery<'a, S>>) -> Result<Self>

impl<'a, S: PartialEq + SearchType> PartialEq for SearchQuery<'a, S>

fn eq(&self, other: &SearchQuery<'a, S>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PostQuery for SearchQuery<'a, FilteredSearch<AlbumsFilter>>

fn header(&self) -> Map<String, Value>

fn path(&self) -> &str

fn params(&self) -> Option<Cow<'_, str>>

impl<'a> PostQuery for SearchQuery<'a, FilteredSearch<ArtistsFilter>>

fn header(&self) -> Map<String, Value>

fn path(&self) -> &str

fn params(&self) -> Option<Cow<'_, str>>

impl<'a> PostQuery for SearchQuery<'a, FilteredSearch<CommunityPlaylistsFilter>>

fn header(&self) -> Map<String, Value>

fn path(&self) -> &str

fn params(&self) -> Option<Cow<'_, str>>

impl<'a> PostQuery for SearchQuery<'a, FilteredSearch<EpisodesFilter>>

fn header(&self) -> Map<String, Value>

fn path(&self) -> &str

fn params(&self) -> Option<Cow<'_, str>>

impl<'a> PostQuery for SearchQuery<'a, FilteredSearch<FeaturedPlaylistsFilter>>

fn header(&self) -> Map<String, Value>

fn path(&self) -> &str

fn params(&self) -> Option<Cow<'_, str>>

impl<'a> PostQuery for SearchQuery<'a, FilteredSearch<PlaylistsFilter>>

fn header(&self) -> Map<String, Value>

fn path(&self) -> &str

fn params(&self) -> Option<Cow<'_, str>>

impl<'a> PostQuery for SearchQuery<'a, FilteredSearch<PodcastsFilter>>

fn header(&self) -> Map<String, Value>

fn path(&self) -> &str

fn params(&self) -> Option<Cow<'_, str>>

impl<'a> PostQuery for SearchQuery<'a, FilteredSearch<ProfilesFilter>>

fn header(&self) -> Map<String, Value>

fn path(&self) -> &str

fn params(&self) -> Option<Cow<'_, str>>

impl<'a> PostQuery for SearchQuery<'a, FilteredSearch<SongsFilter>>

fn header(&self) -> Map<String, Value>

fn path(&self) -> &str

fn params(&self) -> Option<Cow<'_, str>>

impl<'a> PostQuery for SearchQuery<'a, FilteredSearch<VideosFilter>>

fn header(&self) -> Map<String, Value>

fn path(&self) -> &str

fn params(&self) -> Option<Cow<'_, str>>

impl<'a, S: UnfilteredSearchType> PostQuery for SearchQuery<'a, S>

fn header(&self) -> Map<String, Value>

fn path(&self) -> &str

fn params(&self) -> Option<Cow<'_, str>>

impl<'a, A: AuthToken> Query<A> for SearchQuery<'a, FilteredSearch<AlbumsFilter>>

type Output = Vec<SearchResultAlbum>

type Method = PostMethod

impl<'a, A: AuthToken> Query<A> for SearchQuery<'a, FilteredSearch<ArtistsFilter>>

type Output = Vec<SearchResultArtist>

type Method = PostMethod

impl<'a, A: AuthToken> Query<A> for SearchQuery<'a, FilteredSearch<CommunityPlaylistsFilter>>

type Output = Vec<SearchResultPlaylist>

type Method = PostMethod

impl<'a, A: AuthToken> Query<A> for SearchQuery<'a, FilteredSearch<EpisodesFilter>>

type Output = Vec<SearchResultEpisode>

type Method = PostMethod

impl<'a, A: AuthToken> Query<A> for SearchQuery<'a, FilteredSearch<FeaturedPlaylistsFilter>>

type Output = Vec<SearchResultFeaturedPlaylist>

type Method = PostMethod

impl<'a, A: AuthToken> Query<A> for SearchQuery<'a, FilteredSearch<PlaylistsFilter>>

type Output = Vec<SearchResultPlaylist>

type Method = PostMethod

impl<'a, A: AuthToken> Query<A> for SearchQuery<'a, FilteredSearch<PodcastsFilter>>

type Output = Vec<SearchResultPodcast>

type Method = PostMethod

impl<'a, A: AuthToken> Query<A> for SearchQuery<'a, FilteredSearch<ProfilesFilter>>

type Output = Vec<SearchResultProfile>

type Method = PostMethod

impl<'a, A: AuthToken> Query<A> for SearchQuery<'a, FilteredSearch<SongsFilter>>

type Output = Vec<SearchResultSong>

type Method = PostMethod

impl<'a, A: AuthToken> Query<A> for SearchQuery<'a, FilteredSearch<VideosFilter>>

type Output = Vec<SearchResultVideo>

type Method = PostMethod

impl<'a, S: UnfilteredSearchType, A: AuthToken> Query<A> for SearchQuery<'a, S>

type Output = SearchResults

type Method = PostMethod

impl<'a, S: SearchType> StructuralPartialEq for SearchQuery<'a, S>