vkclient 6.0.0

Vk Api client implementation
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

//! # Base VK API client realisation.
//! This client supports zstd compression and msgpack format of VK API. It works with http2-only connections.
//!
//! ## VK API Clients list:
//! * [API client](VkApi)
//! * [Uploader client](upload::VkUploader)
//! * [Long Poll Client](longpoll::VkLongPoll)
//!
//! ## Usage
//! ```rust
//! use vkclient::{List, VkApi, VkApiResult};
//! use serde::{Serialize, Deserialize};
//!
//! fn demo() {
//!     let access_token = String::new();
//!     let client: VkApi = vkclient::VkApiBuilder::new(access_token).into();
//!
//!     async {
//!         let users = get_users_info(&client).await.unwrap();
//!         let _ = users;
//!     };
//! }
//!
//! async fn get_users_info(client: &VkApi) -> VkApiResult<Vec<UsersGetResponse>> {
//!     client.send_request("users.get", UsersGetRequest {
//!         user_ids: List(vec![1,2]),
//!         fields: List(vec!["id", "sex"]),
//!    }).await
//! }
//!
//! #[derive(Serialize)]
//! struct UsersGetRequest<'a> {
//!     user_ids: List<Vec<usize>>,
//!     fields: List<Vec<&'a str>>,
//! }
//!
//! #[derive(Deserialize)]
//! struct UsersGetResponse {
//!     id: i64,
//!     first_name: String,
//!     last_name: String,
//!     sex: u8,
//! }
//! ```
//!
//! ## Features
//! * [`compression_zstd`](crate::Compression) - enabled by default. Adds zstd compression support;
//! * [`compression_gzip`](crate::Compression) - enabled by default. Adds gzip compression support;
//! * [`encode_json`](crate::Encoding) - enabled by default. Adds json encoding support;
//! * [`encode_msgpack`](crate::Encoding) - enabled by default. Adds msgpack encoding support;
//! * [`uploader`](crate::upload::VkUploader) - enabled by default. Adds file uploads support.
//! * [`longpoll`](crate::longpoll::VkLongPoll) - enabled by default. Adds longpoll support.
//! * [`longpoll_stream`](crate::longpoll::VkLongPoll::subscribe) - enabled by default. Adds converter long poll queries to futures stream.

mod builder;
mod inner;
mod structs;
mod vkapi;

#[cfg(feature = "longpoll")]
pub mod longpoll;
#[cfg(feature = "uploader")]
pub mod upload;
mod wrapper;

pub use builder::VkApiBuilder;
pub use structs::*;
pub use vkapi::*;
pub use wrapper::VkApiWrapper;