Struct BucketSet 

pub struct BucketSet { /* private fields */ }

A collection for buckets in an exponential histogram.

The set stores sparse, sorted buckets as a tuple of their midpoint (Point), and count of occurrences.

Implementations

impl BucketSet

pub fn new() -> Self

Create a new empty BucketSet.

This method does not allocate.

pub fn try_from_str(s: &str) -> Result<Self, ParseBucketSetError>

Parse a BucketSet from its raw textual representation.

pub fn observe(&mut self, value: Point)

Observe a Point computed from a raw value.

The count for this point will be incremented by 1.

All points should be computed from the same scale.

Panics

This method will panic if adding count to an existing entry in value would overflow.

pub fn observe_all(&mut self, value: Point, count: u64)

Observe count instances of a Point computed from a raw value.

The count for this point will be incremented by count.

All points should be computed from the same scale.

Panics

This method will panic if adding count to an existing entry in value would overflow.

pub fn remap(&mut self, map: impl FnMut(Point) -> Point)

Remap and merge buckets.

This method can be used to rescale the buckets to a coarser granularity in combination with the crate::metric::exp::midpoint function. It accepts a closure that maps stored bucket Points to new values. When multiple buckets map to the same new value, their counts will be summed.

Panics

This method will panic if adding count to an existing entry in value would overflow. This can happen when merging buckets with large counts.

pub fn len(&self) -> usize

Get the number of buckets currently in the set.

This is not the total count of observed values in all buckets, just the count of buckets themselves. See BucketSet::total for the total count.

pub fn total(&self) -> u64

Get the total count of observed values.

pub fn clear(&mut self)

Clear all buckets, allowing the allocation to be re-used.

pub fn get(&self, value: Point) -> Option<u64>

Get the count for a particular bucket.

pub fn first(&self) -> Option<(Point, u64)>

Get the first (lowest numbered) bucket.

pub fn last(&self) -> Option<(Point, u64)>

Get the last (highest numbered) bucket.

pub fn iter(&self) -> Iter<'_>

Iterate over buckets in order.

Trait Implementations

impl Clone for BucketSet

fn clone(&self) -> BucketSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BucketSet

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

Formats the value using the given formatter.

impl Display for BucketSet

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

Formats the value using the given formatter.

impl Eq for BucketSet

impl<'a> Extend<(Point, u64)> for BucketSet

fn extend<I: IntoIterator<Item = (Point, u64)>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<'a> FromIterator<(Point, u64)> for BucketSet

fn from_iter<I: IntoIterator<Item = (Point, u64)>>(iter: I) -> Self

Creates a value from an iterator.

impl FromStr for BucketSet

type Err = ParseBucketSetError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'a> FromValue<'a> for BucketSet

fn from_value(v: Value<'a>) -> Option<Self>

Perform the conversion.

impl<'a> IntoIterator for &'a BucketSet

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

type Item = (Point, u64)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for BucketSet

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BucketSet

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BucketSet

impl ToValue for BucketSet

fn to_value(&self) -> Value<'_>

Perform the conversion.

impl Value for BucketSet

Available on crate feature sval only.

fn stream<'sval, S: Stream<'sval> + ?Sized>( &'sval self, stream: &mut S, ) -> Result

Stream this value through a Stream.

fn tag(&self) -> Option<Tag>

Get the tag of this value, if there is one.

fn to_bool(&self) -> Option<bool>

Try convert this value into a boolean.

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

Try convert this value into a 32bit binary floating point number.

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

Try convert this value into a 64bit binary floating point number.

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

Try convert this value into a signed 8bit integer.

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

Try convert this value into a signed 16bit integer.

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

Try convert this value into a signed 32bit integer.

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

Try convert this value into a signed 64bit integer.

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

Try convert this value into a signed 128bit integer.

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

Try convert this value into an unsigned 8bit integer.

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

Try convert this value into an unsigned 16bit integer.

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

Try convert this value into an unsigned 32bit integer.

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

Try convert this value into an unsigned 64bit integer.

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

Try convert this value into an unsigned 128bit integer.

fn to_text(&self) -> Option<&str>

Try convert this value into a text string.

fn to_binary(&self) -> Option<&[u8]>

Try convert this value into a bitstring.