kitsu 0.1.1

Unofficial Rust HTTP client implementations for the Kitsu API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

//! # kitsu.rs
//!
//! An unofficial Rust library acting as a wrapper around the [Kitsu] API,
//! offering implementations for both asynchronous hyper (v0.11) and synchronous
//! reqwest (v0.8).
//!
//! **note:** The library supports retrieval from the API, but does not currently
//! support authenticated requests.
//!
//! ### Compile features
//!
//! - **hyper-support**: Compiles with `hyper` support
//! - **reqwest-support**: Compliles with `reqwest` support (*default*)
//!
//! ### Installation
//!
//! Add the following to your `Cargo.toml` file:
//!
//! ```toml
//! [dependencies]
//! kitsu = "0.1"
//! ```
//!
//! To enable both `hyper` and `reqwest` support:
//!
//! ```toml
//! [dependencies.kitsu]
//! version = "0.1"
//! features = ["hyper-support", "reqwest-support"]
//! ```
//!
//! To enable `hyper` but not `reqwest` support:
//!
//! ```toml
//! [dependencies.kitsu]
//! version = "0.1"
//! default-features = false
//! features = ["hyper-support"]
//! ```
//!
//! ### Examples
//!
//! Using reqwest, search for an anime using a string taken from user input:
//!
//! ```rust,no_run
//! extern crate kitsu;
//! # #[cfg(feature = "reqwest")]
//! extern crate reqwest;
//!
//!
//! # #[cfg(feature = "reqwest")]
//! # fn main() {
//! #
//! use kitsu::KitsuReqwestRequester;
//! use reqwest::Client;
//! use std::io::{self, Write};
//!
//! // Create the reqwest Client.
//! let client = Client::new();
//!
//! // Read an anime name to search for from the users input.
//! let mut input = String::new();
//! print!("Enter an anime name to search for:\n>");
//! let _ = io::stdout().flush();
//! io::stdin().read_line(&mut input).expect("Error reading input");
//! let input_trimmed = input.trim();
//!
//! // Search for the anime.
//! let anime = client.search_anime(|f| f.filter("text", input_trimmed))
//!     .expect("Error searching for anime");
//!
//! // Print out the response of the request.
//! if let Some(ref picked) = anime.data.first() {
//!     let title = &picked.attributes.canonical_title;
//!
//!     if let Some(ref rating) = picked.attributes.average_rating {
//!         println!("Found Anime: {} - {}", title, rating);
//!     } else {
//!        println!("Found Anime: {} - ??", title);
//!     }
//! } else {
//!     println!("No Anime Found.");
//! }
//! # }
//! # #[cfg(not(feature = "reqwest"))]
//! # fn main() { }
//! ```
//!
//! For more examples, refer to the [examples] folder.
//!
//! ### License
//!
//! ISC. View the full license [here][license file].
//!
//! [Kitsu]: https://kitsu.io
//! [examples]: https://github.com/zeyla/kitsu.rs/blob/master/examples
//! [license file]: https://github.com/zeyla/kitsu.rs/blob/master/README.md
#![deny(missing_docs)]

#[macro_use] extern crate serde_derive;

extern crate percent_encoding;
extern crate serde;
extern crate serde_json;

#[cfg(feature = "hyper")]
extern crate futures;
#[cfg(feature = "hyper")]
extern crate hyper;
#[cfg(feature = "reqwest")]
extern crate reqwest;

pub mod bridge;
pub mod builder;
pub mod model;

mod error;

pub use error::{Error, Result};

#[cfg(feature = "hyper")]
pub use bridge::hyper::KitsuRequester as KitsuHyperRequester;
#[cfg(feature = "reqwest")]
pub use bridge::reqwest::KitsuRequester as KitsuReqwestRequester;

/// Kitsu API Url
pub const API_URL: &'static str = "https://kitsu.io/api/edge";