rvk 0.13.0

Crate for accessing VK (VKontakte) 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

# `rvk`
[![version][badges/version]][crates.io/rvk]
[![downloads][badges/downloads]][crates.io/rvk]
[![license][badges/license]][license]

> A crate for accessing VK (VKontakte) API in Rust (synchronously).

Changelog is available [here][changelog].

# Modules

- [`api`][modules/api] - works with the API;
- [`error`][modules/error] - handles errors that may occur during an API call;
- [`methods`][modules/methods] - contains **API [methods][vk/methods]**;
- [`objects`][modules/objects] - contains **API [objects][vk/objects]**. See also [note about objects](#objects).

# Usage
Add the dependency to your project:

<sub>`Cargo.toml`</sub>
```toml
[dependencies]
rvk = "0.13"
```

Now you can take a look at `rvk`'s [API documentation][docs.rs/rvk] to learn more about the available functions.

# Example

To use this example, you will **also** need the [`serde_json`][crates.io/serde_json] crate to deserialize the API response:

<sub>`Cargo.toml`</sub>
```toml
[dependencies]
serde_json = "1.0"
```

<sub>`main.rs`</sub>
```rust
use rvk::{methods::*, objects::user::User, APIClient, Params};
use serde_json::from_value;

fn main() {
    let api = APIClient::new("your_access_token"); // Create an API Client

    let mut params = Params::new(); // Create a HashMap to store parameters
    params.insert("user_ids".into(), "1".into());

    let res = users::get(&api, params);

    match res {
        Ok(v) => { // v is `serde_json::Value`
            let users: Vec<User> = from_value(v).unwrap();
            let user = &users[0];

            println!(
                "User #{} is {} {}.",
                user.id, user.first_name, user.last_name
            );
        }
        Err(e) => println!("{}", e),
    };
}
```

# Notes
### Objects
Due to the nature of the VK API documentation, it is not always clear if the value is always passed or not, and sometimes the data type is not defined.

If you spot any mistakes or bugs, please [report them][issues]!

[crates.io/rvk]: https://crates.io/crates/rvk
[crates.io/serde_json]: https://crates.io/crates/serde_json

[docs.rs/rvk]: https://docs.rs/rvk

[license]: https://github.com/u32i64/rvk/blob/master/LICENSE
[changelog]: https://github.com/u32i64/rvk/blob/master/CHANGELOG.md

[issues]: https://github.com/u32i64/rvk/issues

[badges/version]: https://img.shields.io/crates/v/rvk.svg?style=for-the-badge
[badges/downloads]: https://img.shields.io/crates/d/rvk.svg?style=for-the-badge
[badges/license]: https://img.shields.io/crates/l/rvk.svg?style=for-the-badge

[modules/api]: https://docs.rs/rvk/*/rvk/api/index.html
[modules/error]: https://docs.rs/rvk/*/rvk/error/index.html
[modules/methods]: https://docs.rs/rvk/*/rvk/methods/index.html
[modules/objects]: https://docs.rs/rvk/*/rvk/objects/index.html

[vk/methods]: https://vk.com/dev/methods
[vk/objects]: https://vk.com/dev/objects