apalis-board-api 1.0.0-rc.7

HTTP utilities for managing apalis task queues.
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

/// Exposes Actix framework routes.
#[cfg(feature = "actix")]
pub mod actix;
/// Exposes Axum framework routes.
#[cfg(feature = "axum")]
pub mod axum;

/// Trait for registering routes with a backend
pub trait RegisterRoute<B, T> {
    /// Register routes with the given backend
    #[must_use]
    fn register(self, backend: B) -> Self;
}

/// Builder for API routes
#[derive(Clone, Debug)]
pub struct ApiBuilder<R> {
    router: R,
    #[allow(unused)]
    /// may not be used in some conditional compilation
    root: bool,
}

impl<R> ApiBuilder<R> {
    /// Create a new ApiBuilder with default settings
    pub fn new(router: R) -> Self {
        Self { router, root: true }
    }
    /// Create a new ApiBuilder with a custom scope
    /// If `register_root` is true, the root routes (/queues, /tasks, /workers, /overview)
    /// will be registered on the provided scope.
    pub fn new_with_router(router: R, register_root: bool) -> Self {
        Self {
            router,
            root: register_root,
        }
    }

    /// Finalize the builder and return the router
    pub fn build(self) -> R {
        self.router
    }
}