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
// 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::{ClusterDefinitionSet, VirtualHostDefinitionSet},
};
use serde_json::Value;
use super::client::{Client, Result};
use std::fmt::Display;
impl<E, U, P> Client<E, U, P>
where
E: Display,
U: Display,
P: Display,
{
/// Exports cluster-wide definitions as a JSON document.
/// This includes all virtual hosts, users, permissions, policies, queues, streams, exchanges, bindings, runtime parameters.
///
/// See [Definition Export and Import](https://www.rabbitmq.com/docs/definitions) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn export_cluster_wide_definitions(&self) -> Result<String> {
self.export_cluster_wide_definitions_as_string()
}
/// Exports cluster-wide definitions as a JSON document.
/// This includes all virtual hosts, users, permissions, policies, queues, streams, exchanges, bindings, runtime parameters.
///
/// See [Definition Export and Import](https://www.rabbitmq.com/docs/definitions) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn export_cluster_wide_definitions_as_string(&self) -> Result<String> {
let response = self.http_get("definitions", None, None)?;
let response = response.text()?;
Ok(response)
}
/// Exports cluster-wide definitions as a data structure.
/// This includes all virtual hosts, users, permissions, policies, queues, streams, exchanges, bindings, runtime parameters.
///
/// See [Definition Export and Import](https://www.rabbitmq.com/docs/definitions) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn export_cluster_wide_definitions_as_data(&self) -> Result<ClusterDefinitionSet> {
let response = self.http_get("definitions", None, None)?;
let response = response.json()?;
Ok(response)
}
/// Exports definitions of a single virtual host as a JSON document.
/// This includes the permissions, policies, queues, streams, exchanges, bindings, runtime parameters associated
/// with the given virtual host.
///
/// See [Definition Export and Import](https://www.rabbitmq.com/docs/definitions) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn export_vhost_definitions(&self, vhost: &str) -> Result<String> {
self.export_vhost_definitions_as_string(vhost)
}
/// Exports definitions of a single virtual host as a JSON document.
/// This includes the permissions, policies, queues, streams, exchanges, bindings, runtime parameters associated
/// with the given virtual host.
///
/// See [Definition Export and Import](https://www.rabbitmq.com/docs/definitions) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn export_vhost_definitions_as_string(&self, vhost: &str) -> Result<String> {
let response = self.http_get(path!("definitions", vhost), None, None)?;
let response = response.text()?;
Ok(response)
}
/// Exports definitions of a single virtual host as a data structure.
/// This includes the permissions, policies, queues, streams, exchanges, bindings, runtime parameters associated
/// with the given virtual host.
///
/// See [Definition Export and Import](https://www.rabbitmq.com/docs/definitions) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn export_vhost_definitions_as_data(
&self,
vhost: &str,
) -> Result<VirtualHostDefinitionSet> {
let response = self.http_get(path!("definitions", vhost), None, None)?;
let response = response.json()?;
Ok(response)
}
/// Imports cluster-wide definitions from a JSON document value.
///
/// See [Definition Export and Import](https://www.rabbitmq.com/docs/definitions) to learn more.
///
/// Requires the `administrator` user tag.
pub fn import_definitions(&self, definitions: Value) -> Result<()> {
self.import_cluster_wide_definitions(definitions)
}
/// Imports cluster-wide definitions from a JSON document value.
///
/// See [Definition Export and Import](https://www.rabbitmq.com/docs/definitions) to learn more.
///
/// Requires the `administrator` user tag.
pub fn import_cluster_wide_definitions(&self, definitions: Value) -> Result<()> {
self.http_post("definitions", &definitions, None, None)?;
Ok(())
}
/// Imports definitions of a single virtual host from a JSON document value.
///
/// See [Definition Export and Import](https://www.rabbitmq.com/docs/definitions) to learn more.
///
/// Requires the `administrator` user tag.
pub fn import_vhost_definitions(&self, vhost: &str, definitions: Value) -> Result<()> {
self.http_post(path!("definitions", vhost), &definitions, None, None)?;
Ok(())
}
}