opentdb 0.1.0

An implementation of the Open Trivia Database API in Rust <https://opentdb.com>
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

# opentdb-rs

[![Build Status](https://travis-ci.com/Zarthus/opentdb-rs.svg?token=mchp2p7qCC3ksLz8xnwx&branch=master)](https://travis-ci.com/Zarthus/opentdb-rs)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
[![crates.io](https://meritbadge.herokuapp.com/opentdb)](https://crates.io/crates/opentdb)
[![Released API docs](https://docs.rs/opentdb/badge.svg)](https://docs.rs/opentdb)

An implementation of the Open Trivia Database API in Rust <https://opentdb.com>

### Install

```bash
cargo add opentdb
```

### Usage

```rust
extern crate opentdb;

use opentdb::api_request::ApiRequest;
use opentdb::api_response::ApiResponse;

use opentdb::enums::category::Category;
use opentdb::enums::difficulty::Difficulty;
use opentdb::enums::question_type::QuestionType;
use opentdb::enums::encoding::Encoding;

fn main() {
    // Start a new session so that the service remains the questions we've received already.
    let token: String = opentdb::session_new()
        .expect("New Session Creation failed")
        .token;

    // Build a new ApiRequest
    let rq: ApiRequest = opentdb::builder()
        .questions(25)
        .category(Category::Any)
        .difficulty(Difficulty::Any)
        .question_type(QuestionType::All)
        .encoding(Encoding::DefaultEncoding)
        .token(token)
        .build();

    // Create a HTTP request from an ApiRequest, send it, and parse the JSON into an ApiResponse.
    let rs: ApiResponse = opentdb::send_and_parse(rq).unwrap();

    println!("Response Code: {:?}", rs.response_code);
    for results in rs.results {
        println!("  [{}] Question: {}", results.category, results.question);
    }
}
```

### Limitations

- Only 1 Category can be requested per API Call. To get questions from any category, don't specify a category.
- A Maximum of 50 Questions can be retrieved per call.

### Missing

The following API lookups are not implemented:

Category Lookup: Returns the entire list of categories and ids in the database.

- https://opentdb.com/api_category.php

Category Question Count Lookup: Returns the number of questions in the database, in a specific category.

- https://opentdb.com/api_count.php?category=CATEGORY_ID_HERE

Global Question Count Lookup: Returns the number of ALL questions in the database. Total, Pending, Verified, and Rejected.

- https://opentdb.com/api_count_global.php

### License and Acknowledgements

OpenTDB itself is licensed under the [MIT license](LICENSE)

OpenTDB depends on `serde` (for (de)serialization) and `reqwest` (for sending HTTP requests).