Enum ArrayFormat 

#[repr(u8)]
pub enum ArrayFormat {
    Default = 0,
    LinearHistogram = 1,
    ExponentialHistogram = 2,
}

Format in which the array will be read.

Histograms are formatted with its parameters inline with its buckets:

• …N parameters…
• underflow_bucket
• …M buckets…
• overflow_bucket

Helper functions exist to make it easier to work with these formats:

• ArrayFormat::underflow_bucket_index returns the index of the underflow bucket, which also happens to be the first bucket.
• ArrayFormat::extra_slots returns the number of additional slots necessary to store parameters and underflow buckets.

Variants

Default = 0

Regular array, it stores N values in N slots.

LinearHistogram = 1

The array is a linear histogram with N buckets and N+4 slots, which are:

• param_floor_value
• param_step_size
• underflow_bucket
• …N buckets…
• overflow_bucket

ExponentialHistogram = 2

The array is an exponential histogram with N buckets and N+5 slots, which are:

• param_floor_value
• param_initial_step
• param_step_multiplier
• underflow_bucket
• …N buckets…
• overflow_bucket

Implementations

impl ArrayFormat

pub const fn underflow_bucket_index(self) -> usize

Return index of the underflow bucket for histograms, or 0 if not a histogram.

pub const fn overflow_bucket_index(self, buckets: usize) -> usize

Return index of the overflow bucket for histograms, or 0 if not a histogram. Depends on the number of buckets.

pub const fn extra_slots(self) -> usize

Return count of extra slots needed for storing parameters and underflow/overflow slots.

Trait Implementations

impl Clone for ArrayFormat

fn clone(&self) -> ArrayFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArrayFormat

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

Formats the value using the given formatter.

impl FromPrimitive for ArrayFormat

fn from_i64(n: i64) -> Option<ArrayFormat>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<ArrayFormat>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl PartialEq for ArrayFormat

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

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl Copy for ArrayFormat

impl Eq for ArrayFormat

impl StructuralPartialEq for ArrayFormat