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

use crate::core::payload::Dispatchable;

/// Interface for interacting with message status
pub trait Status: Dispatchable {
    /// Change message status to available
    ///
    /// ```
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::Status;
    ///
    /// let mut message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// message.requeue();
    /// ```
    fn requeue(&mut self);

    /// Change message status to "in transit"
    ///
    /// Also, default message implementation increments counter of tries
    ///
    /// ```
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::Status;
    ///
    /// let mut message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// message.reserve();
    /// ```
    fn reserve(&mut self);

    /// Check if message can be requeued
    ///
    /// ```
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::Status;
    ///
    /// let mut message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// assert!(!message.requeueable());
    /// ```
    fn requeueable(&self) -> bool;

    /// Check if message can be reserved
    ///
    /// ```
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::Status;
    ///
    /// let mut message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// assert!(message.reservable());
    /// ```
    fn reservable(&self) -> bool;

    /// Check if message has available tries
    ///
    /// This method was added to help [`TreeDatabase`] correctly identify if message can be reserved later.
    ///
    /// ```
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::Status;
    ///
    /// let mut message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// assert!(message.has_tries());
    ///
    /// message.reserve();
    ///
    /// assert!(!message.has_tries());
    /// ```
    ///
    /// [`TreeDatabase`]: crate::core::db::TreeDatabase
    fn has_tries(&self) -> bool;
}