celers 0.2.0

Celery-compatible distributed task queue for Rust (Facade crate)
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

/// Quick Redis broker setup with sensible defaults
///
/// # Example
/// ```rust,ignore
/// use celers::quick_start::redis_broker;
///
/// let broker = redis_broker("localhost:6379", "celery")?;
/// ```
#[cfg(feature = "redis")]
pub fn redis_broker(
    url: &str,
    queue: &str,
) -> std::result::Result<crate::RedisBroker, celers_core::error::CelersError> {
    let full_url = if url.starts_with("redis://") {
        url.to_string()
    } else {
        format!("redis://{}", url)
    };
    crate::RedisBroker::new(&full_url, queue)
}

/// Quick PostgreSQL broker setup
///
/// # Example
/// ```rust,ignore
/// use celers::quick_start::postgres_broker;
///
/// let broker = postgres_broker(
///     "postgresql://user:pass@localhost/db",
///     "celery"
/// ).await?;
/// ```
#[cfg(feature = "postgres")]
pub async fn postgres_broker(
    url: &str,
    queue: &str,
) -> std::result::Result<crate::PostgresBroker, celers_core::error::CelersError> {
    crate::PostgresBroker::with_queue(url, queue).await
}

/// Quick MySQL broker setup
///
/// # Example
/// ```rust,ignore
/// use celers::quick_start::mysql_broker;
///
/// let broker = mysql_broker(
///     "mysql://user:pass@localhost/db",
///     "celery"
/// ).await?;
/// ```
#[cfg(feature = "mysql")]
pub async fn mysql_broker(
    url: &str,
    queue: &str,
) -> std::result::Result<crate::MysqlBroker, celers_core::error::CelersError> {
    crate::MysqlBroker::with_queue(url, queue).await
}

/// Quick AMQP (RabbitMQ) broker setup
///
/// # Example
/// ```rust,ignore
/// use celers::quick_start::amqp_broker;
///
/// let broker = amqp_broker(
///     "amqp://guest:guest@localhost:5672",
///     "celery"
/// ).await?;
/// ```
#[cfg(feature = "amqp")]
pub async fn amqp_broker(
    url: &str,
    queue: &str,
) -> std::result::Result<crate::AmqpBroker, celers_core::error::CelersError> {
    crate::AmqpBroker::new(url, queue)
        .await
        .map_err(|e| celers_core::error::CelersError::Broker(e.to_string()))
}

/// Quick SQS broker setup
///
/// # Example
/// ```rust,ignore
/// use celers::quick_start::sqs_broker;
///
/// let broker = sqs_broker("celery").await?;
/// ```
#[cfg(feature = "sqs")]
pub async fn sqs_broker(
    queue: &str,
) -> std::result::Result<crate::SqsBroker, celers_core::error::CelersError> {
    crate::SqsBroker::new(queue)
        .await
        .map_err(|e| celers_core::error::CelersError::Broker(e.to_string()))
}

/// Build a WorkerConfig with sensible defaults
///
/// # Example
/// ```rust,ignore
/// use celers::quick_start::{redis_broker, default_worker_config};
///
/// let config = default_worker_config()?;
/// // Use config to create worker
/// ```
pub fn default_worker_config() -> std::result::Result<crate::WorkerConfig, String> {
    use celers_worker::WorkerConfigBuilder;

    WorkerConfigBuilder::new()
        .concurrency(num_cpus::get())
        .build()
}

/// Build a WorkerConfig with custom concurrency
///
/// # Example
/// ```rust,ignore
/// use celers::quick_start::worker_config_with_concurrency;
///
/// let config = worker_config_with_concurrency(8)?;
/// ```
pub fn worker_config_with_concurrency(
    concurrency: usize,
) -> std::result::Result<crate::WorkerConfig, String> {
    use celers_worker::WorkerConfigBuilder;

    WorkerConfigBuilder::new().concurrency(concurrency).build()
}