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
//! `GET /api/queues` and related queue endpoints.
use crate::api::encode_segment;
use crate::types::queue::{
AckMode, GetMessage, PayloadEncoding, Queue, QueueAction, QueueDeclareOptions,
};
use crate::{Client, Paginated, PaginationQuery, Result};
impl Client {
/// `GET /api/queues` — lists all queues across all vhosts.
pub async fn list_queues(&self) -> Result<Vec<Queue>> {
self.get("queues", None).await
}
/// `GET /api/queues` with pagination parameters — returns a
/// [`Paginated`] page of queues.
pub async fn list_queues_paged(&self, q: &PaginationQuery) -> Result<Paginated<Queue>> {
self.get("queues", Some(q)).await
}
/// `GET /api/queues/{vhost}` — lists all queues in a single vhost.
/// The vhost is percent-encoded (e.g. `/` becomes `%2F`).
pub async fn list_queues_in_vhost(&self, vhost: &str) -> Result<Vec<Queue>> {
self.get(&format!("queues/{}", encode_segment(vhost)), None)
.await
}
/// `GET /api/queues/{vhost}/{name}` — returns details of a single
/// queue. Both segments are percent-encoded.
pub async fn get_queue(&self, vhost: &str, name: &str) -> Result<Queue> {
self.get_ctx(
&queue_path(vhost, name),
None,
&format!("queue '{name}' in vhost '{vhost}'"),
)
.await
}
/// `PUT /api/queues/{vhost}/{name}` — declares a queue.
pub async fn declare_queue(
&self,
vhost: &str,
name: &str,
opts: &QueueDeclareOptions,
) -> Result<()> {
self.put(&queue_path(vhost, name), opts).await
}
/// `DELETE /api/queues/{vhost}/{name}` — deletes a queue.
pub async fn delete_queue(&self, vhost: &str, name: &str) -> Result<()> {
self.delete_ctx(
&queue_path(vhost, name),
&format!("queue '{name}' in vhost '{vhost}'"),
)
.await
}
/// `DELETE /api/queues/{vhost}/{name}/contents` — purges all messages
/// from a queue.
pub async fn purge_queue(&self, vhost: &str, name: &str) -> Result<()> {
self.delete_ctx(
&format!("{}/contents", queue_path(vhost, name)),
&format!("queue '{name}' in vhost '{vhost}'"),
)
.await
}
/// `POST /api/queues/{vhost}/{name}/actions` — performs a queue action
/// (`sync` or `cancel_sync`, for quorum / classic mirrored queues).
pub async fn queue_action(&self, vhost: &str, name: &str, action: QueueAction) -> Result<()> {
self.post(
&format!("{}/actions", queue_path(vhost, name)),
&serde_json::json!({"action": action.as_str()}),
)
.await
}
/// `POST /api/queues/{vhost}/{name}/get` — fetches up to `count`
/// messages from the queue without consuming them client-side.
///
/// Whether the messages are requeued server-side depends on `ack`;
/// `encoding` controls how payloads are returned (`auto` returns the
/// payload as a string when it is valid UTF-8, else base64; `base64`
/// always base64-encodes).
pub async fn get_messages(
&self,
vhost: &str,
name: &str,
count: u32,
ack: AckMode,
encoding: PayloadEncoding,
) -> Result<Vec<GetMessage>> {
self.post_json(
&format!("{}/get", queue_path(vhost, name)),
&serde_json::json!({
"count": count,
"ackmode": ack.as_str(),
"encoding": encoding.as_str(),
}),
)
.await
}
}
/// Percent-encode a vhost and queue name into a `queues/{vhost}/{name}`
/// relative path segment prefix.
fn queue_path(vhost: &str, name: &str) -> String {
format!("queues/{}/{}", encode_segment(vhost), encode_segment(name))
}