sentry-core 0.48.3

Core Sentry library used for instrumentation and integration development.
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

//! Includes the [`TransportOptions`] struct.

use std::borrow::Cow;

use sentry_types::Dsn;

#[cfg(feature = "client")]
use crate::client_report::Recorder as ClientReportRecorder;
use crate::ClientOptions;

/// Options for a transport.
#[derive(Debug)]
#[must_use]
#[non_exhaustive]
pub struct TransportOptions {
    /// The transport's Sentry DSN.
    pub dsn: Dsn,
    /// The user agent sent with transport requests.
    pub user_agent: Cow<'static, str>,
    /// An optional HTTP proxy to use.
    pub http_proxy: Option<Cow<'static, str>>,
    /// An optional HTTPS proxy to use.
    pub https_proxy: Option<Cow<'static, str>>,
    /// Whether TLS certificate validation should be disabled.
    pub accept_invalid_certs: bool,
    /// A handle for recording lost Sentry data.
    #[cfg(feature = "client")]
    pub client_report_recorder: ClientReportRecorder,
}

impl TransportOptions {
    /// Try to convert a [`&ClientOptions`](ClientOptions) to a [`TransportOptions`] by extracting
    /// the relevant fields from the `ClientOptions`.
    ///
    /// This method is provided so that code which expects [`TransportOptions`] can be
    /// backwards-compatible with older code, which provides `ClientOptions`.
    ///
    /// Returns [`None`] if `options.dsn` is `None`, `Some(_)` otherwise.
    pub fn try_from_client_options(options: &ClientOptions) -> Option<Self> {
        let ClientOptions {
            dsn,
            http_proxy,
            https_proxy,
            accept_invalid_certs,
            user_agent,
            ..
        } = options;

        dsn.as_ref().cloned().map(|dsn| Self {
            dsn,
            user_agent: user_agent.clone(),
            http_proxy: http_proxy.clone(),
            https_proxy: https_proxy.clone(),
            accept_invalid_certs: *accept_invalid_certs,
            #[cfg(feature = "client")]
            client_report_recorder: ClientReportRecorder::new_no_op(),
        })
    }

    /// Converts these [`TransportOptions`] into [`ClientOptions`].
    ///
    /// This method is provided for backwards-compatibility with custom transports which cannot
    /// be contructed from [`TransportOptions`] because they expect [`ClientOptions`].
    ///
    /// Any fields on [`ClientOptions`] which are not present in [`TransportOptions`] will be
    /// set to their default values.
    pub(crate) fn into_client_options(self) -> ClientOptions {
        let Self {
            dsn,
            user_agent,
            http_proxy,
            https_proxy,
            accept_invalid_certs,
            #[cfg(feature = "client")]
                client_report_recorder: _,
        } = self;

        let dsn = Some(dsn);

        ClientOptions {
            dsn,
            user_agent,
            http_proxy,
            https_proxy,
            accept_invalid_certs,
            ..Default::default()
        }
    }
}