capp-queue 0.7.2

Common things i use to build Rust CLI tools for web crawlers.
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

//! This module provides a trait for interacting with task storage.
//! The storage allows tasks to be pushed to and popped from a queue,
//! and also allows tasks to be set and retrieved by their UUID.

use async_trait::async_trait;
use serde::{Serialize, de::DeserializeOwned};
use std::{fmt::Debug, hash::Hash, sync::Arc};

use super::TaskQueueError;
use crate::task::{Task, TaskId};

#[async_trait]
pub trait TaskQueue<Data>
where
    Data: Debug + Clone + Serialize + DeserializeOwned + Send + Sync + 'static,
{
    async fn push(&self, task: &Task<Data>) -> Result<(), TaskQueueError>;
    async fn pop(&self) -> Result<Task<Data>, TaskQueueError>;
    async fn ack(&self, task_id: &TaskId) -> Result<(), TaskQueueError>;
    async fn nack(&self, task: &Task<Data>) -> Result<(), TaskQueueError>;
    async fn set(&self, task: &Task<Data>) -> Result<(), TaskQueueError>;

    /// Move any tasks left in the in-flight set back to the queue. Called once
    /// at runtime startup to recover work owned by a previous process that
    /// crashed before acking. Returns the number of tasks recovered.
    async fn recover_inflight(&self) -> Result<u64, TaskQueueError> {
        Ok(0)
    }
}

pub type AbstractTaskQueue<D> = Arc<dyn TaskQueue<D> + Send + Sync>;

// Trait used for round-robin queues
pub trait HasTagKey {
    type TagValue: Hash + Eq + Clone + ToString + Send + Sync + 'static;
    fn get_tag_value(&self) -> Self::TagValue;
}