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

//  Copyright 2017 Palantir Technologies, Inc.
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.

//! Sampling flags.

/// Flags used to control sampling.
#[derive(Debug, Copy, Clone)]
pub struct SamplingFlags {
    pub(crate) sampled: Option<bool>,
    debug: bool,
}

impl Default for SamplingFlags {
    fn default() -> SamplingFlags {
        SamplingFlags::builder().build()
    }
}

impl SamplingFlags {
    /// Returns a builder used to construct `SamplingFlags`.
    pub fn builder() -> Builder {
        Builder {
            sampled: None,
            debug: false,
        }
    }

    /// Determines if sampling has been requested for this context.
    ///
    /// A value of `None` indicates that the service working in the context is
    /// responsible for determining if it should be sampled.
    pub fn sampled(&self) -> Option<bool> {
        self.sampled
    }

    /// Determines if this context is in debug mode.
    ///
    /// Debug contexts should always be sampled, regardless of the value of
    /// `sampled()`.
    pub fn debug(&self) -> bool {
        self.debug
    }
}

/// A builder type for `SamplingFlags`.
pub struct Builder {
    sampled: Option<bool>,
    debug: bool,
}

impl From<SamplingFlags> for Builder {
    fn from(flags: SamplingFlags) -> Builder {
        Builder {
            sampled: flags.sampled,
            debug: flags.debug,
        }
    }
}

impl Builder {
    /// Sets the sampling request for this context.
    ///
    /// Defaults to `None`.
    pub fn sampled(&mut self, sampled: bool) -> &mut Builder {
        self.sampled = Some(sampled);
        self
    }

    /// Sets the debug flag for this request.
    ///
    /// Defaults to `false`.
    pub fn debug(&mut self, debug: bool) -> &mut Builder {
        self.debug = debug;
        self
    }

    /// Constructs `SamplingFlags`.
    pub fn build(&self) -> SamplingFlags {
        SamplingFlags {
            sampled: if self.debug {
                Some(true)
            } else {
                self.sampled
            },
            debug: self.debug,
        }
    }
}