s2n-quic-dc 0.83.0

Internal crate used by s2n-quic
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

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

#[cfg(any(test, feature = "testing"))]
use s2n_quic_core::event::snapshot;

pub use s2n_quic_core::event::{Event, IntoEvent, Timestamp};

/// Provides metadata related to an event
pub trait Meta: core::fmt::Debug {
    /// A context from which the event is being emitted
    ///
    /// An event can occur in the context of an Endpoint or Connection
    fn subject(&self) -> api::Subject;
}

impl Meta for api::ConnectionMeta {
    fn subject(&self) -> api::Subject {
        builder::Subject::Connection { id: self.id }.into_event()
    }
}

impl Meta for api::EndpointMeta {
    fn subject(&self) -> api::Subject {
        builder::Subject::Endpoint {}.into_event()
    }
}

// The generated code is not currently held to the panic lints; suppress them here at the
// module level rather than annotating each generated site (which would be lost on regeneration).
#[allow(
    clippy::panic,
    clippy::unwrap_used,
    clippy::unwrap_in_result,
    clippy::panic_in_result_fn,
    reason = "FIXME: generated event code is not yet audited for the panic lints"
)]
mod generated;
pub use generated::*;

pub mod metrics {
    pub use crate::event::generated::metrics::*;
    pub use s2n_quic_core::event::metrics::Recorder;

    pub mod aggregate {
        pub use crate::event::generated::metrics::aggregate::*;
        pub use s2n_quic_core::event::metrics::aggregate::{
            info, AsVariant, BoolRecorder, Info, Metric, NominalRecorder, Recorder, Registry, Units,
        };

        pub mod probe {
            pub use crate::event::generated::metrics::probe::*;
            pub use s2n_quic_core::event::metrics::aggregate::probe::dynamic;
        }
    }
}

pub mod disabled {
    #[derive(Clone, Debug, Default)]
    pub struct Subscriber(());

    impl super::Subscriber for Subscriber {
        type ConnectionContext = ();

        #[inline]
        fn create_connection_context(
            &self,
            _meta: &super::api::ConnectionMeta,
            _info: &super::api::ConnectionInfo,
        ) -> Self::ConnectionContext {
        }
    }
}