Struct histogram::Builder

pub struct Builder { /* private fields */ }

Expand description

A Builder allows for constructing a Histogram with the desired configuration.

Implementations§

impl Builder

pub fn build(self) -> Result<Histogram, Error>

Consume the Builder and return a Histogram.

pub fn min_resolution(self, width: u64) -> Self

Sets the width of the smallest bucket in the Histogram.

As the Histogram uses base-2 internally, the resolution will be the largest power of two that is less than or equal to the provided value. For example, if the minimum resolution is set to 10, the width of the smallest bucket will be 8.

pub fn min_resolution_range(self, value: u64) -> Self

Sets the maximum value that the minimum resolution extends to.

This value should be greater than the minimum resolution. If the value provided is not a power of two, the smallest power of two that is larger than the provided value will be used.

pub fn maximum_value(self, value: u64) -> Self

Sets the maximum value that can be recorded into the Histogram.

If the value provided is not a power of two, the smallest power of two that is larger than the provided value will be used.

Auto Trait Implementations§

impl RefUnwindSafe for Builder

impl Send for Builder

impl Sync for Builder

impl Unpin for Builder

impl UnwindSafe for Builder

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.