consulrs 0.1.0

An asynchronous Rust client library for the Hashicorp Consul 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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

use crate::api::Features;

use super::common::KVPair;
use consulrs_derive::QueryEndpoint;
use derive_builder::Builder;
use rustify_derive::Endpoint;
use serde::Serialize;
use std::fmt::Debug;

/// ## Read Key
/// This endpoint returns the specified key.
///
/// * Path: kv/{self.key}
/// * Method: GET
/// * Response: [ReadKeyResponse]
/// * Reference: https://www.consul.io/api-docs/kv#read-key
#[derive(Builder, Debug, Default, Endpoint, QueryEndpoint)]
#[endpoint(path = "kv/{self.key}", response = "Vec<KVPair>", builder = "true")]
#[builder(setter(into, strip_option), default)]
pub struct ReadKeyRequest {
    #[endpoint(skip)]
    pub features: Option<Features>,
    #[endpoint(skip)]
    pub key: String,
    #[endpoint(query)]
    pub dc: Option<String>,
    #[endpoint(query)]
    pub ns: Option<String>,
    #[endpoint(query)]
    pub recurse: Option<bool>,
}

/// ## Read Key
/// This endpoint returns the raw value of the specified key.
///
/// * Path: kv/{self.key}
/// * Method: GET
/// * Response: [ReadKeyResponse]
/// * Reference: https://www.consul.io/api-docs/kv#read-key
#[derive(Builder, Debug, Default, Endpoint, QueryEndpoint)]
#[endpoint(path = "kv/{self.key}", response = "Vec<u8>", builder = "true")]
#[builder(setter(into, strip_option), default)]
pub struct ReadRawKeyRequest {
    #[endpoint(skip)]
    pub features: Option<Features>,
    #[endpoint(skip)]
    pub key: String,
    #[endpoint(query)]
    pub dc: Option<String>,
    #[endpoint(query)]
    pub ns: Option<String>,
    #[endpoint(query)]
    #[builder(setter(skip), default = "true")]
    pub raw: bool,
}

/// ## Read Keys
/// This endpoint returns a list of key names at the specified key.
///
/// * Path: kv/{self.key}
/// * Method: GET
/// * Response: [Vec<String>]
/// * Reference: https://www.consul.io/api-docs/kv#read-key
#[derive(Builder, Debug, Default, Endpoint, QueryEndpoint)]
#[endpoint(path = "kv/{self.key}", response = "Vec<String>", builder = "true")]
#[builder(setter(into, strip_option), default)]
pub struct ReadKeysRequest {
    #[endpoint(skip)]
    pub features: Option<Features>,
    #[endpoint(skip)]
    pub key: String,
    #[endpoint(query)]
    pub dc: Option<String>,
    #[endpoint(query)]
    #[builder(setter(skip), default = "true")]
    pub keys: bool,
    #[endpoint(query)]
    pub ns: Option<String>,
    #[endpoint(query)]
    pub raw: Option<bool>,
    #[endpoint(query)]
    pub recurse: Option<bool>,
    #[endpoint(query)]
    pub separator: Option<String>, // Only valid when `keys` is set
}

/// ## Create/Update Key
/// This endpoint updates the value of the specified key.
///
/// * Path: kv/{self.key}
/// * Method: PUT
/// * Response: [bool]
/// * Reference: https://www.consul.io/api-docs/kv#create-update-key
#[derive(Builder, Debug, Default, Endpoint, QueryEndpoint)]
#[endpoint(
    path = "kv/{self.key}",
    method = "PUT",
    response = "bool",
    builder = "true"
)]
#[builder(setter(into, strip_option), default)]
pub struct SetKeyRequest {
    #[endpoint(skip)]
    pub features: Option<Features>,
    #[endpoint(skip)]
    pub key: String,
    #[endpoint(raw)]
    pub value: Vec<u8>,
    #[endpoint(query)]
    pub acquire: Option<String>,
    #[endpoint(query)]
    pub cas: Option<u64>,
    #[endpoint(query)]
    pub dc: Option<String>,
    #[endpoint(query)]
    pub flags: Option<u64>,
    #[endpoint(query)]
    pub ns: Option<String>,
    #[endpoint(query)]
    pub release: Option<String>,
}

/// ## Delete Key
/// This endpoint deletes a single key or all keys sharing a prefix.
///
/// * Path: kv/{self.key}
/// * Method: DELETE
/// * Response: [bool]
/// * Reference: https://www.consul.io/api-docs/kv#delete-key
#[derive(Builder, Debug, Default, Endpoint, QueryEndpoint)]
#[endpoint(
    path = "kv/{self.key}",
    method = "DELETE",
    response = "bool",
    builder = "true"
)]
#[builder(setter(into, strip_option), default)]
pub struct DeleteKeyRequest {
    #[endpoint(skip)]
    pub features: Option<Features>,
    #[endpoint(skip)]
    pub key: String,
    #[endpoint(query)]
    pub cas: Option<u64>,
    #[endpoint(query)]
    pub dc: Option<String>,
    #[endpoint(query)]
    pub ns: Option<String>,
    #[endpoint(query)]
    pub recurse: Option<bool>,
}