Struct relay_metrics::BucketsView

pub struct BucketsView<T> { /* private fields */ }

A view into a slice of metric buckets.

The view can be used to iterate over a large slice of metric data slicing even into the buckets themselves.

                   Full View
 /---------------------------------------------\
[[C:1], [C:12], [D:0, 1, 2, 3, 5, 5], [S:42, 75]]
 \--------------------------/  \---------------/
           View 1                    View 2

Iterating over a BucketsView yields BucketView items, only the first and last elements may be partial buckets.

In the above example View 1 has a partial bucket at the end and View 2 has a partial bucket in the beginning.

Using the above example, iterating over View 1 yields the buckets: [C:1], [C:12], [D:0, 1, 2, 3].

Implementations

impl<T> BucketsView<T>

where T: AsRef<[Bucket]>,

pub fn new(buckets: T) -> Self

Creates a new buckets view containing all data from the slice.

pub fn len(&self) -> usize

Returns the amount of partial or full buckets in the view.

pub fn is_empty(&self) -> bool

Returns whether the view contains any buckets.

pub fn as_slice(&self) -> BucketsView<&[Bucket]>

Returns the same bucket view as a bucket view over a slice.

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

Iterator over all buckets in the view.

pub fn by_size(self, size_in_bytes: usize) -> BucketsViewBySizeIter<T>

Iterator which slices the source view into segments with an approximate size of size_in_bytes.

Trait Implementations

impl<T: Clone> Clone for BucketsView<T>

fn clone(&self) -> BucketsView<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for BucketsView<T>

where T: AsRef<[Bucket]>,

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

Formats the value using the given formatter.

impl<'a> From<&'a [Bucket]> for BucketsView<&'a [Bucket]>

fn from(value: &'a [Bucket]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Vec<Bucket>> for BucketsView<&'a [Bucket]>

fn from(value: &'a Vec<Bucket>) -> Self

Converts to this type from the input type.

impl<'a, T> IntoIterator for &'a BucketsView<T>

where T: AsRef<[Bucket]>,

type Item = BucketView<'a>

The type of the elements being iterated over.

type IntoIter = BucketsViewIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for BucketsView<&'a [Bucket]>

type Item = BucketView<'a>

The type of the elements being iterated over.

type IntoIter = BucketsViewIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> Serialize for BucketsView<T>

where T: AsRef<[Bucket]>,

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy> Copy for BucketsView<T>