Struct WallhavenClient 

pub struct WallhavenClient { /* private fields */ }

A wallhaven api client.

There are two ways of constructing this object, with or without an api key, see WallhavenClient::new and WallhavenClient::with_key for more details

Examples

client.wallpaper("someid").await?;
client.search(None).await?;

let req = SearchRequestBuilder::default().build()?;
client.search(Some(req)).await?;

And so on! Check out each methods/models for more informations

Implementations

impl WallhavenClient

pub fn with_key(api_key: impl AsRef<str>) -> Result<Self, Error>

Constructs WallhavenClient with an api key Check out WallhavenClient::new to construct an instance without an api key. The api key will be passed to the X-API-Key headers.

Errors

• Error::InvalidApiKey when an invalid api key is passed as argument
• Error::BuildingClient when something went wrong with the Client builder, this shouldn’t happen and you probably should file an issue

pub fn new() -> Result<Self, Error>

Constructs WallhavenClient without an api key. Check out WallhavenClient::with_key to construct an instance with an api key.

Errors

• Error::BuildingClient when something went wrong with the Client builder, this shouldn’t happen and you probably should file an issue

pub async fn wallpaper( &self, id: impl AsRef<str>, ) -> Result<WallpaperDetails, Error>

Fetches a wallpaper by id

Errors

• Error::UrlParsingError when the URL cannot be parsed
• Error::SendingRequest an error while sending the request, you can get more details with the underlying error
• Error::DecodingJson an error decoding the JSON, either wallhaven sent a wrong json, or we wrote a bad model
• Error::UnknownRequestError - an unknown error when sending/receiving the request, you can match further the underlying error

pub async fn search( &self, params: Option<SearchRequest>, ) -> Result<SearchResult, Error>

Searches for wallpapers matching the request

Errors

• Error::UrlParsingError when the URL cannot be parsed
• Error::SendingRequest an error while sending the request, you can get more details with the underlying error
• Error::DecodingJson an error decoding the JSON, either wallhaven sent a wrong json, or we wrote a bad model
• Error::UnknownRequestError - an unknown error when sending/receiving the request, you can match further the underlying error

pub async fn collections( &self, username: impl Into<Option<String>>, ) -> Result<Vec<UserCollection>, Error>

Fetches all the UserCollection of a certain user

Defaults to the current if no username is provided and an api key is used

Errors

• Error::UrlParsingError when the URL cannot be parsed
• Error::SendingRequest an error while sending the request, you can get more details with the underlying error
• Error::DecodingJson an error decoding the JSON, either wallhaven sent a wrong json, or we wrote a bad model
• Error::UnknownRequestError - an unknown error when sending/receiving the request, you can match further the underlying error

pub async fn collection_items( &self, username: impl AsRef<str>, id: u64, params: Option<CollectionItemsRequest>, ) -> Result<SearchResult, Error>

Gets the collection’s wallpapers.

Errors

• Error::UrlParsingError when the URL cannot be parsed
• Error::SendingRequest an error while sending the request, you can get more details with the underlying error
• Error::DecodingJson an error decoding the JSON, either wallhaven sent a wrong json, or we wrote a bad model
• Error::UnknownRequestError - an unknown error when sending/receiving the request, you can match further the underlying error

pub async fn tag(&self, id: u64) -> Result<Tag, Error>

Fetches a Tag by its id

Errors

• Error::UrlParsingError when the URL cannot be parsed
• Error::SendingRequest an error while sending the request, you can get more details with the underlying error
• Error::DecodingJson an error decoding the JSON, either wallhaven sent a wrong json, or we wrote a bad model
• Error::UnknownRequestError - an unknown error when sending/receiving the request, you can match further the underlying error

pub async fn user_settings(&self) -> Result<UserSettings, Error>

Fetches the UserSettings of the current user. Only works if the api key was provided.

Errors

• Error::UrlParsingError when the URL cannot be parsed
• Error::SendingRequest an error while sending the request, you can get more details with the underlying error
• Error::DecodingJson an error decoding the JSON, either wallhaven sent a wrong json, or we wrote a bad model
• Error::UnknownRequestError - an unknown error when sending/receiving the request, you can match further the underlying error

pub async fn download_wallpaper( &self, wallpaper: &impl HasPath, ) -> Result<impl Stream<Item = Result<Bytes>>, Error>

Downloads a any wallpaper type (e.g. WallhavenDetails or WallhavenSummary)

Errors

• Error::SendingRequest an error while sending the request, you can get more details with the underlying error
• Error::UnknownRequestError - an unknown error when sending/receiving the request, you can match further the underlying error

pub async fn download_thumbnail( &self, thumbnail: &Thumbnails, resolution: ThumbnailResolution, ) -> Result<impl Stream<Item = Result<Bytes>>, Error>

Downloads a Thumbnails

Errors

• Error::SendingRequest an error while sending the request, you can get more details with the underlying error
• Error::UnknownRequestError - an unknown error when sending/receiving the request, you can match further the underlying error

Trait Implementations

impl Clone for WallhavenClient

fn clone(&self) -> WallhavenClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.