Struct megamind::Client

pub struct Client { /* private fields */ }

An HTTP client for interacting with the Genius API.

Essentially just a thin wrapper around reqwest::Client, meaning that if you want more control/need to access a missing endpoint then you can just use the data models with Reqwest directly.

This also means that you can clone this client freely and should not use std::sync::Arc or std::rc::Rc, much like reqwest::Client.

Implementations

impl Client

pub async fn account(&self) -> Result<Response<AccountResponse>, ClientError>

Get the account info for the currently authed user.

Requires scope: me.

Returns

The current user.

pub async fn annotation( &self, id: u32 ) -> Result<Response<AnnotationResponse>, ClientError>

Get an annotation.

Args

• id - A Genius ID.

Returns

The annotation associated with the ID.

pub async fn artist( &self, id: u32 ) -> Result<Response<ArtistResponse>, ClientError>

Get an artist.

Args

• id - A Genius ID.

Returns

The artist associated with the ID.

pub async fn referents( &self, created_by: Option<u32>, associated: Option<ReferentAssociation>, per_page: Option<u8>, page: Option<u8> ) -> Result<Response<ReferentsResponse>, ClientError>

Get referents.

Args

• created_by - A Genius ID.
• associated - The associated web page or song.
• per_page - A per-page limit.
• page - A page offset, starting at 1.

Returns

The referents that are associated with the web page or song and/or are created by a user with the given Genius ID. Results follow the per_page and page rules, and there are some failure cases that the argument types can’t prevent so please visit the Genius documentation for more information.

pub async fn search<S: AsRef<str>>( &self, query: S ) -> Result<Response<SearchResponse>, ClientError>

Get search results.

Args

• query - A search term to match against.

Returns

Search results associated with the query.

pub async fn song(&self, id: u32) -> Result<Response<SongResponse>, ClientError>

Get a song.

Args

• id - A Genius ID.

Returns

The song associated with the ID.

pub async fn user(&self, id: u32) -> Result<Response<UserResponse>, ClientError>

Get a user.

Args

• id - A Genius ID.

Returns

The user associated with the ID.

pub async fn web_pages( &self, raw_annotatable_url: Option<&str>, canonical_url: Option<&str>, og_url: Option<&str> ) -> Result<Response<WebPageResponse>, ClientError>

Get a web page.

Args

• raw_annotatable_url - The URL as it would appear in a browser.
• canonical_url - The URL as specified by an appropriate tag in a page’s .
• og_url - The URL as specified by an og:url tag in a page’s .

Returns

The web page associated with the above arguments.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.