apalis-core 1.0.0

Core for apalis: simple, extensible multithreaded background processing 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
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

use futures_sink::Sink;
use futures_util::SinkExt;
use std::pin::Pin;
use std::task::{Context, Poll};

use tracing::Span;

use crate::{backend::*, task::Task, worker::context::WorkerContext};

/// Instruments the inner [Backend] with the provided `Span`, returning an
/// `Instrumented` wrapper.
#[derive(Debug, Clone)]
pub struct Instrumented<B> {
    backend: B,
    span: Span,
}

impl<B> Instrumented<B> {
    /// Create a new `Instrumented` backend with the given tracing span.
    pub fn new(backend: B, span: Span) -> Self {
        Self { backend, span }
    }

    /// Returns the wrapped backend.
    pub fn inner(&self) -> &B {
        &self.backend
    }

    /// Returns a mutable reference to the wrapped backend.
    pub fn inner_mut(&mut self) -> &mut B {
        &mut self.backend
    }

    /// Returns the tracing span.
    pub fn span(&self) -> &Span {
        &self.span
    }

    /// Unwraps the instrumented backend.
    pub fn into_inner(self) -> B {
        self.backend
    }
}

impl<B> Backend for Instrumented<B>
where
    B: Backend,
{
    type Task = B::Task;
    type Error = B::Error;

    fn poll_ready(
        &mut self,
        cx: &mut Context<'_>,
        worker: &WorkerContext,
    ) -> Poll<Result<(), Self::Error>> {
        let _entered = self.span.enter();
        self.backend.poll_ready(cx, worker)
    }

    fn poll_next(
        &mut self,
        cx: &mut Context<'_>,
        worker: &WorkerContext,
    ) -> Poll<Option<Result<Self::Task, Self::Error>>> {
        let _entered = self.span.enter();
        self.backend.poll_next(cx, worker)
    }

    fn poll_close(
        &mut self,
        cx: &mut Context<'_>,
        worker: &WorkerContext,
    ) -> Poll<Result<(), Self::Error>> {
        let _entered = self.span.enter();
        self.backend.poll_close(cx, worker)
    }
}

impl<B, T, Err> Sink<T> for Instrumented<B>
where
    B: Sink<T, Error = Err> + Unpin,
{
    type Error = Err;
    fn start_send(self: Pin<&mut Self>, item: T) -> Result<(), Self::Error> {
        let this = self.get_mut();
        let _entered = this.span.enter();
        this.backend.start_send_unpin(item)
    }
    fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        let this = self.get_mut();
        let _entered = this.span.enter();
        this.backend.poll_ready_unpin(cx)
    }
    fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        let this = self.get_mut();
        let _entered = this.span.enter();
        this.backend.poll_flush_unpin(cx)
    }
    fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        let this = self.get_mut();
        let _entered = this.span.enter();
        this.backend.poll_close_unpin(cx)
    }
}

delegate_expose!(
    impl<B> for Instrumented<B>
    where {
        B: Send + Sync,
        B::Task: Send + Clone + 'static,
    }
    => backend
);

delegate_config!(Instrumented<B>, backend);
delegate_deref!(Instrumented<B>, backend);
delegate_codec!(Instrumented<B>, backend);