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
// Copyright (C) 2023-2025 RabbitMQ Core Team (teamrabbitmq@gmail.com)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use crate::{path, responses};
use super::client::{Client, Result};
use std::fmt::Display;
impl<E, U, P> Client<E, U, P>
where
E: Display,
U: Display,
P: Display,
{
/// Lists all stream publishers across the cluster.
///
/// Requires the `monitoring` user tag. Does not modify state.
/// Can be used by restricted monitoring users with the `monitoring` tag and only the `read`, `configure` permissions.
pub async fn list_stream_publishers(&self) -> Result<Vec<responses::StreamPublisher>> {
self.get_api_request(path!("stream", "publishers")).await
}
/// Lists stream publishers publishing to the given virtual host.
///
/// Requires the `management` user tag and have `read` permissions on the vhost. Does not modify state.
pub async fn list_stream_publishers_in(
&self,
virtual_host: &str,
) -> Result<Vec<responses::StreamPublisher>> {
self.get_api_request(path!("stream", "publishers", virtual_host))
.await
}
/// Lists stream publishers publishing to the given stream.
/// Useful for detecting publishers that are publishing to a specific stream.
///
/// Requires the `management` user tag and have `read` permissions on the vhost. Does not modify state.
pub async fn list_stream_publishers_of(
&self,
virtual_host: &str,
name: &str,
) -> Result<Vec<responses::StreamPublisher>> {
self.get_api_request(path!("stream", "publishers", virtual_host, name))
.await
}
/// Lists stream publishers on the given stream connection.
/// Use this function for inspecting stream publishers on a specific connection.
///
/// Requires the `management` user tag and have `read` permissions on the vhost. Does not modify state.
pub async fn list_stream_publishers_on_connection(
&self,
virtual_host: &str,
name: &str,
) -> Result<Vec<responses::StreamPublisher>> {
self.get_api_request(path!(
"stream",
"connections",
virtual_host,
name,
"publishers"
))
.await
}
/// Lists all stream consumers across the cluster.
///
/// Requires the `monitoring` user tag. Does not modify state.
/// Can be used by restricted monitoring users with the `monitoring` tag and only the `read`, `configure` permissions.
pub async fn list_stream_consumers(&self) -> Result<Vec<responses::StreamConsumer>> {
self.get_api_request(path!("stream", "consumers")).await
}
/// Lists stream consumers on connections in the given virtual host.
///
/// Requires the `management` user tag and have `read` permissions on the vhost. Does not modify state.
pub async fn list_stream_consumers_in(
&self,
virtual_host: &str,
) -> Result<Vec<responses::StreamConsumer>> {
self.get_api_request(path!("stream", "consumers", virtual_host))
.await
}
/// Lists stream consumers on the given stream connection.
/// Use this function for inspecting stream consumers on a specific connection.
///
/// Requires the `management` user tag and have `read` permissions on the vhost. Does not modify state.
pub async fn list_stream_consumers_on_connection(
&self,
virtual_host: &str,
name: &str,
) -> Result<Vec<responses::StreamConsumer>> {
self.get_api_request(path!(
"stream",
"connections",
virtual_host,
name,
"consumers"
))
.await
}
/// Lists all consumers across the cluster.
/// See [Consumers Guide](https://www.rabbitmq.com/docs/consumers) to learn more.
///
/// Requires the `management` user tag and the `read` permissions. Does not modify state.
pub async fn list_consumers(&self) -> Result<Vec<responses::Consumer>> {
self.get_api_request("consumers").await
}
/// Lists all consumers in the given virtual host.
/// See [Consumers Guide](https://www.rabbitmq.com/docs/consumers) to learn more.
///
/// Requires the `management` user tag and have `read` permissions on the vhost. Does not modify state.
pub async fn list_consumers_in(&self, virtual_host: &str) -> Result<Vec<responses::Consumer>> {
self.get_api_request(path!("consumers", virtual_host)).await
}
}