Crate animality

animality.rs

A simple Rust API wrapper that generates images & facts of any animal.

Installation

Add this to your Cargo.toml file's dependencies:

animality = "1.0.0"

Blocking request

extern crate animality;
use animality::{Animality, Animal};
 
fn main() {
  let client = Animality::new("your token here");
   
  // request with the `Animal` enum
  let dog_image = client.image(Animal::Dog).unwrap();
  let dog_fact = client.fact(Animal::Dog).unwrap();
   
  // request from a string (case-insensitive) 
  let cat: Animal = "cat".parse().unwrap();
  let cat_image = client.image(cat).unwrap();
  let cat_fact = client.fact(cat).unwrap();
}

Async request

extern crate animality;
extern crate tokio;
 
use animality::{Animality, Animal, RequestError};
 
#[tokio::main]
async fn main() -> Result<(), RequestError> {
  let client = Animality::new("your token here");
   
  // request with the `Animal` enum
  let dog_image = client.image_async(Animal::Dog).await?;
  let dog_fact = client.fact_async(Animal::Dog).await?;
   
  // request from a string (case-insensitive) 
  let cat: Animal = "cat".parse().unwrap();
  let cat_image = client.image_async(cat).await?;
  let cat_fact = client.fact_async(cat).await?;
 
  Ok(())
}

Structs

Animality

The Animality HTTPS client. This struct handles every request sent and received to the Animality API.

HttpError

If the client receives an invalid HTTP status code, the error would be this.

InvalidAnimalError

Enums

Animal

Represents a list of animals supported by the Animality API.

RequestError

The error whenever the client fails to initiate a request (for various reasons)