Enum CreationError

pub enum CreationError {
    LowIsZero,
    LowExceedsMax,
    HighLessThanTwiceLow,
    SigFigExceedsMax,
    CannotRepresentSigFigBeyondLow,
    UsizeTypeTooSmall,
}

Errors that can occur when creating a histogram.

Variants

LowIsZero

Lowest discernible value must be >= 1.

LowExceedsMax

Lowest discernible value must be <= u64::max_value() / 2 because the highest value is a u64 and the lowest value must be no bigger than half the highest.

HighLessThanTwiceLow

Highest trackable value must be >= 2 * lowest discernible value for some internal calculations to work out. In practice, high is typically much higher than 2 * low.

SigFigExceedsMax

Number of significant digits must be in the range [0, 5]. It is capped at 5 because 5 significant digits is already more than almost anyone needs, and memory usage scales exponentially as this increases.

CannotRepresentSigFigBeyondLow

Cannot represent sigfig worth of values beyond the lowest discernible value. Decrease the significant figures, lowest discernible value, or both.

This could happen if low is very large (like 2^60) and sigfigs is 5, which requires 18 additional bits, which would then require more bits than will fit in a u64. Specifically, the exponent of the largest power of two that is smaller than the lowest value and the bits needed to represent the requested significant figures must sum to 63 or less.

UsizeTypeTooSmall

The usize type is too small to represent the desired configuration. Use fewer significant figures or a lower max.

Trait Implementations

impl Clone for CreationError

fn clone(&self) -> CreationError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreationError

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

Formats the value using the given formatter.

impl Display for CreationError

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

Formats the value using the given formatter.

impl Error for CreationError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for CreationError

fn eq(&self, other: &CreationError) -> 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 Copy for CreationError

impl Eq for CreationError

impl StructuralPartialEq for CreationError