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
//! # [Giphy] API wrapper for Rust
//!
//! The library provides a wrapper for [Giphy HTTP API].
//!
//! ## Features
//! Version `0.4.0` is modern-Rust implementation providing all the methods for
//! searching and retrieving GIFs from [Giphy] using `v1` API. Both synchronous
//! and asynchronous styles are supported by the library.
//!
//! Stickers and posting GIFs to [Giphy] is currently not supported.
//!
//! ## Examples
//! ### Synchronous API
//! Create a synchronous [`reqwest::blocking::Client`] and [`SyncApi`] object holding your API key
//!
//! ```
//! use giphy::v1::sync::*;
//!
//! let client = reqwest::blocking::Client::new();
//! let api = SyncApi::new("[your Giphy API key]".to_string(), client);
//! ```
//!
//! Then create and customise an appropriate request object from [`giphy::v1::gifs`] module
//! to make the request.
//!
//! For example, to search for gifs related to "tacos"
//!
//! ```no_run
//! # use giphy::v1::sync::*;
//! use giphy::v1::gifs::SearchRequest;
//! # let client = reqwest::blocking::Client::new();
//! # let api = SyncApi::new("[your Giphy API key]".to_string(), client);
//!
//! let response = SearchRequest::new("tacos") // Create search request
//! .with_limit(10) // Limit the number of objects in response
//! .send_to(&api) // Send the request using SyncApi
//! .unwrap_or_else(|e| // Unwrap the response Result
//! panic!("Search request failed: {:?}", e)
//! );
//!
//! let first_result = response.data // response.data will contain GIFs data
//! .first()
//! .unwrap_or_else(||
//! panic!("No results returned from Giphy")
//! );
//! ```
//!
//! ### Asynchronous API
//! Create an asynchronous [`reqwest::async::Client`] and [`AsyncApi`] object holding your API key
//!
//! ```
//! use giphy::v1::r#async::*;
//!
//! let client = reqwest::Client::new();
//! let api = AsyncApi::new("[your Giphy API key]".to_string(), client);
//! ```
//!
//! The request object is created the same way as when using the synchronous API. The
//! only difference is, [`send_to`] method will return a [`Future`] object when called
//! with [`AsyncApi`].
//!
//! ```no_run
//! # use giphy::v1::r#async::*;
//! use giphy::v1::gifs::SearchRequest;
//!
//! #[tokio::main]
//! async fn main() {
//! # let client = reqwest::Client::new();
//! # let api = AsyncApi::new("[your Giphy API key]".to_string(), client);
//! // Create search request the same way as with synchronous api
//! let response = SearchRequest::new("tacos")
//! .with_limit(10)
//! .send_to(&api) // Send the request using AsyncApi, this returns a Future
//! .await
//! .unwrap();
//!
//! println!("Response: {:?}", response);
//! }
//! ```
//!
//! ### More examples
//! See [examples] for showcase of all the currently possible [Giphy HTTP API]
//! requests in both synchronous and asynchronous style.
//!
//! To run the examples, create a `.env` file in the repository root with the
//! following content
//! ```sh
//! GIPHY_API_KEY_TEST=[your Giphy API key]
//! ```
//!
//! [Giphy]: https://giphy.com
//! [Giphy API]: https://developers.giphy.com/docs/api/
//! [Giphy HTTP API]: https://developers.giphy.com/docs/api/
//! [`reqwest`]: https://docs.rs/reqwest
//! [`v1`]: ./v1/index.html
//! [`reqwest::Client`]: ../reqwest/struct.Client.html
//! [`reqwest::async::Client`]: ../reqwest/async/struct.Client.html
//! [`SyncApi`]: v1/sync/struct.SyncApi.html
//! [`AsyncApi`]: v1/async/struct.AsyncApi.html
//! [`giphy::v1::gifs`]: v1/gifs/index.html
//! [examples]: https://github.com/cfiet/giphy-rs/tree/master/examples
//! [`tokio`]: ../tokio/index.html
extern crate futures;
extern crate reqwest;
extern crate serde_derive;
extern crate dotenv;
extern crate tokio;