Crate rusty_hyrule_compendium 

This crate is a Rust library for the Hryule Compendium API

The resources provided by the above API as of version two and this create exposes a client CompendiumClient that has convienent methods to fetch associated data:

use rusty_hyrule_compendium::blocking::{CompendiumApiClient, CompendiumClient};
use rusty_hyrule_compendium::domain::inputs::EntryIdentifier;
use rusty_hyrule_compendium::Result;

fn main() -> Result<()> {
    // Preconfigured client using v2 of the API
    let client = CompendiumClient::default();
    // Requests can fail for a number of reasons, see the error module for available errors
    let monster_entry = client.monster(EntryIdentifier::Id(123))?;
    // "white-maned lynel"
    let monster_name = monster_entry.name();
    // "https://botw-compendium.herokuapp.com/api/v2/entry/white-maned_lynel/image"
    let image = monster_entry.image();
    Ok(())
}

Modules

blocking

Blocking module

domain

The domain representations

Enums

CompendiumError

Possible errors while retrieving requested data

Type Aliases

Result

The Compendium result type