Struct BucketOptions 

#[non_exhaustive]
pub struct BucketOptions {
    pub options: Option<Options>,
    /* private fields */
}

BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.

A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

options: Option<Options>

Exactly one of these three fields must be set.

Implementations

impl BucketOptions

pub fn new() -> Self

pub fn set_options<T: Into<Option<Options>>>(self, v: T) -> Self

Sets the value of options.

Note that all the setters affecting options are mutually exclusive.

pub fn linear_buckets(&self) -> Option<&Box<Linear>>

The value of options if it holds a LinearBuckets, None if the field is not set or holds a different branch.

pub fn set_linear_buckets<T: Into<Box<Linear>>>(self, v: T) -> Self

Sets the value of options to hold a LinearBuckets.

Note that all the setters affecting options are mutually exclusive.

pub fn exponential_buckets(&self) -> Option<&Box<Exponential>>

The value of options if it holds a ExponentialBuckets, None if the field is not set or holds a different branch.

pub fn set_exponential_buckets<T: Into<Box<Exponential>>>(self, v: T) -> Self

Sets the value of options to hold a ExponentialBuckets.

Note that all the setters affecting options are mutually exclusive.

pub fn explicit_buckets(&self) -> Option<&Box<Explicit>>

The value of options if it holds a ExplicitBuckets, None if the field is not set or holds a different branch.

pub fn set_explicit_buckets<T: Into<Box<Explicit>>>(self, v: T) -> Self

Sets the value of options to hold a ExplicitBuckets.

Note that all the setters affecting options are mutually exclusive.

Trait Implementations

impl Clone for BucketOptions

fn clone(&self) -> BucketOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BucketOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BucketOptions

fn default() -> BucketOptions

Returns the “default value” for a type.

impl Message for BucketOptions

fn typename() -> &'static str

The typename of this message.

impl PartialEq for BucketOptions

fn eq(&self, other: &BucketOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BucketOptions