tencentcloud 0.3.0

tencentcloud rust generic sdk
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

//! the [`Api`] trait allows user define the tencentcloud an api
//!
//! ## Examples:
//!
//! ```rust
//! use serde::{Deserialize, Serialize};
//! use tencentcloud::api::Api;
//!
//! #[derive(Debug, Copy, Clone)]
//! pub struct TextTranslate;
//!
//! #[derive(Debug, Clone, Serialize)]
//! pub struct TextTranslateRequest {
//!     #[serde(rename = "SourceText")]
//!     pub source_text: String,
//!     #[serde(rename = "Source")]
//!     pub source: String,
//!     #[serde(rename = "Target")]
//!     pub target: String,
//!     #[serde(rename = "ProjectId")]
//!     pub project_id: i64,
//! }
//!
//! #[derive(Debug, Clone, Deserialize)]
//! pub struct TextTranslateResponse {
//!     #[serde(rename = "Source")]
//!     pub source: String,
//!     #[serde(rename = "Target")]
//!     pub target: String,
//!     #[serde(rename = "TargetText")]
//!     pub target_text: String,
//! }
//!
//! impl Api for TextTranslate {
//!     type Request<'a> = TextTranslateRequest where Self: 'a;
//!     type Response = TextTranslateResponse;
//!     const VERSION: &'static str = "2018-03-21";
//!     const ACTION: &'static str = "TextTranslate";
//!     const SERVICE: &'static str = "tmt";
//!     const HOST: &'static str = "tmt.tencentcloudapi.com";
//! }
//! ```

use std::fmt::Debug;

use serde::{Deserialize, Serialize};

/// tencentcloud api
///
/// the [`Api`] define an api request type, response type and other info
pub trait Api {
    /// the api request type
    type Request<'a>: Serialize + Debug + 'a
    where
        Self: 'a;

    /// the api response type
    type Response: for<'a> Deserialize<'a> + Debug;

    /// the api version, format is `2018-3-21`
    const VERSION: &'static str;

    /// the api action, for example: the tmt text translate is `TextTranslate`
    const ACTION: &'static str;

    /// the api service, for example: the tmt text translate is `tmt`
    const SERVICE: &'static str;

    /// the api host, for example: the tmt text translate is `tmt.tencentcloudapi.com`
    const HOST: &'static str;
}