amqprs 2.1.5

AMQP 0-9-1 client implementation for RabbitMQ
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
use std::fmt;

use amqp_serde::types::{
    AmqpExchangeName, AmqpMessageCount, AmqpQueueName, Boolean, FieldTable, LongLongUint, LongUint,
    Octect, ShortStr, ShortUint,
};
use serde::{Deserialize, Serialize};

mod bit_flag {
    pub mod consume {
        use amqp_serde::types::Octect;
        pub const NO_LOCAL: Octect = 0b0000_0001;
        pub const NO_ACK: Octect = 0b0000_0010;
        pub const EXCLUSIVE: Octect = 0b0000_0100;
        pub const NO_WAIT: Octect = 0b0000_1000;
    }
    pub mod publish {
        use amqp_serde::types::Octect;
        pub const MANDATORY: Octect = 0b0000_0001;
        pub const IMMEDIATE: Octect = 0b0000_0010;
    }
    pub mod nack {
        use amqp_serde::types::Octect;
        pub const MULTIPLE: Octect = 0b0000_0001;
        pub const REQUEUE: Octect = 0b0000_0010;
    }
}

// TX
#[derive(Debug, Serialize, Deserialize)]
pub struct Qos {
    prefetch_size: LongUint,
    prefetch_count: ShortUint,
    global: Boolean,
}

impl Qos {
    pub fn new(prefetch_size: LongUint, prefetch_count: ShortUint, global: Boolean) -> Self {
        Self {
            prefetch_size,
            prefetch_count,
            global,
        }
    }
}

// RX
#[derive(Debug, Serialize, Deserialize)]
pub struct QosOk;

// TX
#[derive(Debug, Serialize, Deserialize)]
pub struct Consume {
    ticket: ShortUint,
    queue: AmqpQueueName,
    consumer_tag: ShortStr,
    bits: Octect,
    arguments: FieldTable,
}

impl Consume {
    pub fn new(
        ticket: ShortUint,
        queue: AmqpQueueName,
        consumer_tag: ShortStr,
        arguments: FieldTable,
    ) -> Self {
        Self {
            ticket,
            queue,
            consumer_tag,
            bits: 0,
            arguments,
        }
    }

    pub fn set_no_local(&mut self, value: bool) {
        if value {
            self.bits |= bit_flag::consume::NO_LOCAL;
        } else {
            self.bits &= !bit_flag::consume::NO_LOCAL;
        }
    }
    pub fn set_no_ack(&mut self, value: bool) {
        if value {
            self.bits |= bit_flag::consume::NO_ACK;
        } else {
            self.bits &= !bit_flag::consume::NO_ACK;
        }
    }
    pub fn set_exclusive(&mut self, value: bool) {
        if value {
            self.bits |= bit_flag::consume::EXCLUSIVE;
        } else {
            self.bits &= !bit_flag::consume::EXCLUSIVE;
        }
    }
    pub fn set_nowait(&mut self, value: bool) {
        if value {
            self.bits |= bit_flag::consume::NO_WAIT;
        } else {
            self.bits &= !bit_flag::consume::NO_WAIT;
        }
    }
}

// RX
#[derive(Debug, Serialize, Deserialize)]
pub struct ConsumeOk {
    pub(crate) consumer_tag: ShortStr,
}

/// Used by channel [`cancel`] callback.
///
/// AMQP method frame [cancel](https://github.com/rabbitmq/amqp-0.9.1-spec/blob/main/docs/amqp-0-9-1-reference.md#basic.cancel).
///
/// [`cancel`]: callbacks/trait.ChannelCallback.html#tymethod.cancel
// TX + RX
#[derive(Debug, Serialize, Deserialize)]
pub struct Cancel {
    consumer_tag: ShortStr,
    no_wait: Boolean,
}

impl Cancel {
    pub(crate) fn new(consumer_tag: ShortStr, no_wait: Boolean) -> Self {
        Self {
            consumer_tag,
            no_wait,
        }
    }

    pub fn consumer_tag(&self) -> &String {
        self.consumer_tag.as_ref()
    }

    pub fn no_wait(&self) -> bool {
        self.no_wait
    }
}

// TX + RX
#[derive(Debug, Serialize, Deserialize)]
pub struct CancelOk {
    pub(crate) consumer_tag: ShortStr,
}

impl CancelOk {
    pub fn new(consumer_tag: ShortStr) -> Self {
        Self { consumer_tag }
    }
}

// TX
#[derive(Debug, Serialize, Deserialize)]
pub struct Publish {
    ticket: ShortUint,
    exchange: AmqpExchangeName,
    routing_key: ShortStr,
    bits: Octect,
}
impl Publish {
    pub fn new(ticket: ShortUint, exchange: AmqpExchangeName, routing_key: ShortStr) -> Self {
        Self {
            ticket,
            exchange,
            routing_key,
            bits: 0,
        }
    }

    pub fn set_mandatory(&mut self, value: bool) {
        if value {
            self.bits |= bit_flag::publish::MANDATORY;
        } else {
            self.bits &= !bit_flag::publish::MANDATORY;
        }
    }
    pub fn set_immediate(&mut self, value: bool) {
        if value {
            self.bits |= bit_flag::publish::IMMEDIATE;
        } else {
            self.bits &= !bit_flag::publish::IMMEDIATE;
        }
    }
}

/// Used by channel [`publish_return`] callback.
///
/// AMQP method frame [return](https://github.com/rabbitmq/amqp-0.9.1-spec/blob/main/docs/amqp-0-9-1-reference.md#basic.return).
///
/// [`publish_return`]: callbacks/trait.ChannelCallback.html#tymethod.publish_return
// RX
#[derive(Debug, Serialize, Deserialize)]
pub struct Return {
    reply_code: ShortUint,
    reply_text: ShortStr,
    exchange: AmqpExchangeName,
    routing_key: ShortStr,
}
impl fmt::Display for Return {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_fmt(format_args!(
            "'{}: {}', (exchange = {}, routing_key = {})",
            self.reply_code(),
            self.reply_text(),
            self.exchange(),
            self.routing_key()
        ))
    }
}
impl Return {
    pub fn reply_code(&self) -> u16 {
        self.reply_code
    }

    pub fn reply_text(&self) -> &String {
        self.reply_text.as_ref()
    }

    pub fn exchange(&self) -> &String {
        self.exchange.as_ref()
    }

    pub fn routing_key(&self) -> &String {
        self.routing_key.as_ref()
    }
}
/// Used by consumer [`consume`] callback.
///
/// AMQP method frame [deliver](https://github.com/rabbitmq/amqp-0.9.1-spec/blob/main/docs/amqp-0-9-1-reference.md#basic.deliver).
///
/// [`consume`]: consumer/trait.AsyncConsumer.html#tymethod.consume
// RX
#[derive(Debug, Serialize, Deserialize)]
pub struct Deliver {
    consumer_tag: ShortStr,
    delivery_tag: LongLongUint,
    redelivered: Boolean,
    exchange: AmqpExchangeName,
    routing_key: ShortStr,
}
impl fmt::Display for Deliver {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_fmt(format_args!("Deliver: consumer_tag = {}, delivery_tag = {}, redelivered = {}, exchange = {}, routing_key = {}",
            self.consumer_tag, self.delivery_tag, self.redelivered, self.exchange, self.routing_key
        ))
    }
}

impl Deliver {
    pub fn consumer_tag(&self) -> &String {
        self.consumer_tag.as_ref()
    }
    pub fn delivery_tag(&self) -> u64 {
        self.delivery_tag
    }

    pub fn redelivered(&self) -> bool {
        self.redelivered
    }

    pub fn exchange(&self) -> &String {
        self.exchange.as_ref()
    }

    pub fn routing_key(&self) -> &String {
        self.routing_key.as_ref()
    }
}

// TX
#[derive(Debug, Serialize, Deserialize)]
pub struct Get {
    ticket: ShortUint,
    queue: AmqpQueueName,
    no_ack: Boolean,
}

impl Get {
    pub fn new(ticket: ShortUint, queue: AmqpQueueName, no_ack: Boolean) -> Self {
        Self {
            ticket,
            queue,
            no_ack,
        }
    }
}
/// Part of [`GetMessage`]
///
/// AMQP method frame [get-ok](https://github.com/rabbitmq/amqp-0.9.1-spec/blob/main/docs/amqp-0-9-1-reference.md#basic.get-ok).
///
/// [`GetMessage`]: channel/type.GetMessage.html
#[derive(Debug, Serialize, Deserialize)]
pub struct GetOk {
    delivery_tag: LongLongUint,
    redelivered: Boolean,
    exchange: AmqpExchangeName,
    routing_key: ShortStr,
    message_count: AmqpMessageCount,
}
impl fmt::Display for GetOk {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_fmt(format_args!("GetOk: delivery_tag = {}, redelivered = {}, exchange = {}, routing_key = {}, message_count = {}",
            self.delivery_tag, self.redelivered, self.exchange, self.routing_key, self.message_count
        ))
    }
}
impl GetOk {
    pub fn delivery_tag(&self) -> u64 {
        self.delivery_tag
    }

    pub fn redelivered(&self) -> bool {
        self.redelivered
    }

    pub fn exchange(&self) -> &String {
        self.exchange.as_ref()
    }

    pub fn routing_key(&self) -> &String {
        self.routing_key.as_ref()
    }

    pub fn message_count(&self) -> u32 {
        self.message_count
    }
}

// RX
#[derive(Debug, Serialize, Deserialize)]
pub struct GetEmpty {
    pub(crate) cluster_id: ShortStr,
}

/// Used by channel [`publish_ack`] callback.
///
/// AMQP method frame [ack](https://github.com/rabbitmq/amqp-0.9.1-spec/blob/main/docs/amqp-0-9-1-reference.md#basic.ack).
///
/// [`publish_ack`]: callbacks/trait.ChannelCallback.html#tymethod.publish_ack
// TX + RX
#[derive(Debug, Serialize, Deserialize)]
pub struct Ack {
    delivery_tag: LongLongUint,
    mutiple: Boolean,
}

impl Ack {
    pub(crate) fn new(delivery_tag: LongLongUint, mutiple: Boolean) -> Self {
        Self {
            delivery_tag,
            mutiple,
        }
    }

    pub fn delivery_tag(&self) -> u64 {
        self.delivery_tag
    }

    pub fn mutiple(&self) -> bool {
        self.mutiple
    }
}

// TX
#[derive(Debug, Serialize, Deserialize)]
pub struct Reject {
    delivery_tag: LongLongUint,
    requeue: Boolean,
}

impl Reject {
    pub fn new(delivery_tag: LongLongUint, requeue: Boolean) -> Self {
        Self {
            delivery_tag,
            requeue,
        }
    }
}

// TX
// Deprecated
// #[derive(Debug, Serialize, Deserialize)]
// pub struct RecoverAsync {
//     requeue: Boolean,
// }

// impl RecoverAsync {
//     pub fn new(requeue: Boolean) -> Self {
//         Self { requeue }
//     }
// }

// TX
#[derive(Debug, Serialize, Deserialize)]
pub struct Recover {
    requeue: Boolean,
}

impl Recover {
    pub fn new(requeue: Boolean) -> Self {
        Self { requeue }
    }
}

// RX
#[derive(Debug, Serialize, Deserialize)]
pub struct RecoverOk;

/// Used by channel [`publish_nack`] callback.
///
/// AMQP method frame [nack](https://github.com/rabbitmq/amqp-0.9.1-spec/blob/main/docs/amqp-0-9-1-reference.md#basic.nack).
///
/// [`publish_nack`]: callbacks/trait.ChannelCallback.html#tymethod.publish_nack
// TX + RX
#[derive(Debug, Serialize, Deserialize)]
pub struct Nack {
    delivery_tag: LongLongUint,
    bits: Octect,
}
impl Nack {
    pub(crate) fn new(delivery_tag: LongLongUint) -> Self {
        Self {
            delivery_tag,
            bits: 0,
        }
    }

    pub fn set_multiple(&mut self, value: bool) {
        if value {
            self.bits |= bit_flag::nack::MULTIPLE;
        } else {
            self.bits &= !bit_flag::nack::MULTIPLE;
        }
    }
    pub fn set_requeue(&mut self, value: bool) {
        if value {
            self.bits |= bit_flag::nack::REQUEUE;
        } else {
            self.bits &= !bit_flag::nack::REQUEUE;
        }
    }

    pub fn delivery_tag(&self) -> u64 {
        self.delivery_tag
    }

    pub fn multiple(&self) -> bool {
        self.bits & bit_flag::nack::MULTIPLE > 0
    }

    pub fn requeue(&self) -> bool {
        self.bits & bit_flag::nack::REQUEUE > 0
    }
}