Struct urbandictionary::Client

pub struct Client(_);

Methods

impl Client

pub fn new(http_client: impl Into<Arc<HttpClient>>) -> Self

Create a new UrbanDictionary client.

Examples

use reqwest::Client as HttpClient;
use urbandictionary::Client;

let http_client = HttpClient::new();
let urban_client = Client::new(http_client);

pub async fn define<'_, '_>(
    &'_ self,
    word: &'_ str
) -> Result<Option<Definition>>

Attempt to retrieve the first definition for a word.

Examples

Retrieve the definition of the word "cat":

use reqwest::Client as HttpClient;
use urbandictionary::Client;

let http_client = HttpClient::new();
let client = Client::new(http_client);
let response = client.define("cat").await?;

if let Some(definition) = response {
    println!("The definition of cat is: {}", definition.definition);
} else {
    println!("No definition found");
}

Errors

Returns Error::Json if there was an error deserializing the response body.

Returns Error::Reqwest if there was an error sending the request.

pub async fn definitions<'_, '_>(&'_ self, word: &'_ str) -> Result<Response>

Attempt to retrieve the definitions for a word.

Examples

Retrieve the definitions for the word "cat":

use reqwest::Client as HttpClient;
use urbandictionary::Client;

let http_client = HttpClient::new();
let client = Client::new(http_client);

let response = client.definitions("cat").await?;

if let Some(definition) = response.definitions.first() {
    println!(
        "The first definition of cat is: {}",
        definition.definition,
    );
} else {
    println!("No definitions found");
}

Errors

Returns Error::Json if there was an error deserializing the response body.

Returns Error::Reqwest if there was an error sending the request.