broccoli_queue 0.4.6

Broccoli is a simple, fast, and reliable job queue for Rust.
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

use super::broker::Broker;
use crate::error::BroccoliError;
use derive_more::Display;

#[async_trait::async_trait]
/// Trait for managing the state of broccoli queues.
pub trait QueueManagement {
    /// Gets the status of the queue with the specified queue name.
    async fn get_queue_status(
        &self,
        queue_name: String,
        disambiguator: Option<String>,
    ) -> Result<QueueStatus, BroccoliError>;
}

#[derive(Debug, Clone, PartialEq, Eq, Display)]
/// Enum representing the type of queue.
pub enum QueueType {
    /// Failed queue.
    #[display("failed")]
    Failed,
    /// Processing queue.
    #[display("processing")]
    Processing,
    /// Main queue.
    #[display("main")]
    Main,
    /// Fairness queue.
    #[display("fairness")]
    Fairness,
}

pub(crate) trait BrokerWithManagement: Broker + QueueManagement {}

#[derive(Debug, Clone)]
/// Struct representing the status of a queue.
pub struct QueueStatus {
    /// Name of the queue.
    pub name: String,
    /// Type of the queue.
    pub queue_type: QueueType,
    /// Size of the queue.
    pub size: usize,
    /// Number of messages that are being processed.
    pub processing: usize,
    /// Number of messages that failed to be processed.
    pub failed: usize,
    /// If the queue is a fairness queue, the number of disambiguators.
    pub disambiguator_count: Option<usize>,
}