Struct histogram::Config

pub struct Config { /* fields omitted */ }

A configuration struct for building custom Histograms.

Methods

impl Config

pub fn new() -> Config

create a new Histogram Config with defaults

Example

let mut c = Histogram::configure();

pub fn precision(self, precision: u32) -> Self

set HistogramConfig precision

Example

let mut c = Histogram::configure();
c.precision(4); // set to 4 significant figures

pub fn max_memory(self, bytes: u32) -> Self

set HistogramConfig memory limit

Example

let mut c = Histogram::configure();
c.max_memory(1024*1024); // cap Histogram at 1MB of data

pub fn max_value(self, max: u64) -> Self

set HistogramConfig value limit

Example

let mut c = Histogram::configure();
c.max_value(1000); // values above 1000 will not be stored

pub fn build(self) -> Option<Histogram>

Build a new histogram based on the current configuration values. Return None if the new histogram would require more than the configured memory size.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Config

impl Default for Config

fn default() -> Config

Returns the "default value" for a type.