Struct icanhazdadjoke_sdk::DadJokeSDK

pub struct DadJokeSDK { /* fields omitted */ }

The structure used for manipulating the ianhazdadjoke API.

Internally, this manages the Hyper Client (for requests) and the User-Agent.

Examples

use icanhazdadjoke_sdk::DadJokeSDK;
let dad_joke_sdk = DadJokeSDK::default(); // uses default user agent

Implementations

impl DadJokeSDK

pub fn new(user_agent: String) -> Self

Initializes the dad joke sdk with the given User-Agent that is sent with requests.

pub async fn get_joke(self, id: String) -> Result<Joke, Box<dyn Error>>

Gets a single joke by its given String id from the API.

Examples

use icanhazdadjoke_sdk::DadJokeSDK;
let dad_joke_sdk = DadJokeSDK::default();
dad_joke_sdk.get_joke("0189hNRf2g".into()).await;

pub async fn get_random_joke(self) -> Result<Joke, Box<dyn Error>>

Gets a random joke from the API.

Examples

use icanhazdadjoke_sdk::DadJokeSDK;
let dad_joke_sdk = DadJokeSDK::default();
dad_joke_sdk.get_random_joke().await;

pub async fn query_jokes(
    self,
    term: String,
    pagination_opts: PaginationOpts
) -> Result<PaginatedData<PaginatedJoke>, Box<dyn Error>>

Searches for jokes that match the given String term and customizes the result pages based upon the PaginationOpts pagination options.

Trait Implementations

impl Debug for DadJokeSDK

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

Formats the value using the given formatter.

impl Default for DadJokeSDK

fn default() -> Self

Returns the “default value” for a type.