rullst-orm 12.1.1

Fast, un-opinionated, database-agnostic ORM and query builder 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

//! Internal, secret-free telemetry wrappers used by generated ORM code.

use std::{pin::Pin, task::Poll};

use futures::Stream;

/// A stream that enters its query span only while the inner stream is polled.
///
/// Keeping the span guard inside `poll_next` avoids holding a tracing guard
/// across an asynchronous suspension point.
#[doc(hidden)]
#[non_exhaustive]
pub struct QueryTelemetryStream<S> {
    inner: Pin<Box<S>>,
    span: tracing::Span,
}

impl<S> Stream for QueryTelemetryStream<S>
where
    S: Stream,
{
    type Item = S::Item;

    fn poll_next(
        self: Pin<&mut Self>,
        context: &mut std::task::Context<'_>,
    ) -> Poll<Option<Self::Item>> {
        let this = self.get_mut();
        let _guard = this.span.enter();
        this.inner.as_mut().poll_next(context)
    }
}

/// Attaches bounded model metadata to every poll of a generated query stream.
#[doc(hidden)]
pub fn instrument_query_stream<S>(
    stream: S,
    model: &'static str,
    table: &'static str,
    operation: &'static str,
) -> QueryTelemetryStream<S>
where
    S: Stream,
{
    QueryTelemetryStream {
        inner: Box::pin(stream),
        span: tracing::info_span!(
            target: "rullst_orm",
            "rullst.orm.query",
            orm.model = model,
            orm.table = table,
            orm.operation = operation,
        ),
    }
}