Struct Search

pub struct Search {
    pub search_text: String,
    pub optional: HashMap<String, Value>,
}

This is a free text search that matches artist and track names.

| Name | Type | Description | |searchText | string | Artist name or track title | |includeNearMatches | bool | (optional) | |includeGenreStations | bool | (optional) |

{
    "searchText": "encore",
    "userAuthToken": "XXX",
    "syncTime": 1335869287
}

Fields

search_text: String

The text to search for in artist names or track titles.

optional: HashMap<String, Value>

Optional parameters on the call

Implementations

impl Search

pub fn and_boolean_option(self, option: &str, value: bool) -> Self

Convenience function for setting boolean flags in the request. (Chaining call)

pub fn include_near_matches(self, value: bool) -> Self

Whether request should include partial matches in the response. (Chaining call)

pub fn include_genre_stations(self, value: bool) -> Self

Whether request should include genre stations in the response. (Chaining call)

Trait Implementations

impl Clone for Search

fn clone(&self) -> Search

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Search

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

Formats the value using the given formatter.

impl<TS: ToString> From<&TS> for Search

fn from(search_text: &TS) -> Self

Converts to this type from the input type.

impl PandoraJsonApiRequest for Search

type Response = SearchResponse

The type that the json response will be deserialized to.

type Error = Error

The Error type to be returned by fallible calls on this trait.

fn encrypt_request(&self) -> bool

Whether the json body of the API call is expected to be encrypted before transmission.

fn get_method(&self) -> String

Returns the name of the Pandora JSON API call in the form that it must appear when making that call.

fn get_json(&self) -> Result<Value, Self::Error>

Returns the root json Value that should be serialized into the body of the API call.

fn request( &self, session: &mut PandoraSession, ) -> Result<RequestBuilder, Self::Error>

Generate an HTTP request that, when send() is called on it, will submit the built request.

fn response<'life0, 'life1, 'async_trait>( &'life0 self, session: &'life1 mut PandoraSession, ) -> Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send + 'async_trait>>

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

Build the request, submit it, and extract the response content from the body json, and deserialize it into the Self::Response type.

impl Serialize for Search

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.