ngtq 0.1.0

A trait-based abstraction layer for task queues with ID and category support
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

use std::sync::{Arc, Mutex};
pub use ngtq_error::{ NGTQError, NGTQErrorType };
mod ngtq_error;

pub trait NGTQ {
    /// Returns an instance of your TaskQueue wrapped in Arc<Mutex<>>
    fn initialise() -> Arc<Mutex<Self>> where Self: Sized;

    /// Returns the current number of tasks in the ID queue
    /// 
    /// # Errors
    /// 
    /// Returns `NGTQError` if there was an issue accessing the queue
    fn get_id_queue_len(&self) -> Result<usize, NGTQError>;

    /// Returns the current number of tasks in a specific category queue
    /// 
    /// # Errors
    /// 
    /// Returns `NGTQError` if there was an issue accessing the queue
    fn get_category_queue_len(&self, category: &str) -> Result<usize, NGTQError>;

    /// Push a new task to the id queue - Return queue size after adding the new task
    /// 
    /// # Errors
    /// 
    /// Returns `NGTQError` if id already exist in queue or there was an issue accessing the queue
    fn push_id_task_to_queue(&mut self, payload: String) -> Result<String, NGTQError>;


    /// Push a new task to the category queue
    /// 
    /// # Errors
    /// 
    /// Returns `NGTQError` there was an issue accessing the queue
    fn push_category_task_to_queue(&mut self, category: String, payload: String) -> Result<(), NGTQError>;

    /// Pull a payload from the id queue based on the givin id - Return payload (String)
    /// 
    /// # Errors
    /// 
    /// Returns `NGTQError` if id do not exist in queue or there was an issue accessing the queue
    fn pull_id_task_from_queue(&mut self, id: &str) -> Result<String, NGTQError>;

    /// Pull a payload from the category queue - Return payload (String)
    /// 
    /// # Errors
    /// 
    /// Returns `NGTQError` if queue for this category do not exist or there was an issue accessing the queue
    fn pull_category_task_from_queue(&mut self, category: &str) -> Result<String, NGTQError>;
}