Skip to main content

BucketSize

Struct BucketSize 

Source
pub struct BucketSize(/* private fields */);
Expand description

Bucket coalescing interval stored in milliseconds.

Validated newtype controlling how aggressively increments are merged into buckets.

Increments occurring within this interval of each other are coalesced into the same bucket, reducing memory usage and improving performance at the cost of timing granularity.

§Validation

  • Must be >= 1
  • Typical values: 10-100 milliseconds

§Trade-offs

Larger values (50-100ms):

  • Lower memory usage and overhead
  • Coarser rejection metadata

Smaller values (1-20ms):

  • More accurate timing and rejection metadata
  • Higher memory usage

§Examples

use trypema::BucketSize;

let coalescing = BucketSize::milliseconds(10).unwrap();
assert_eq!(coalescing.as_milliseconds(), 10);

let aggressive = BucketSize::milliseconds(100).unwrap();
let precise = BucketSize::milliseconds_or_panic(1);
let _ = (aggressive, precise);

// Invalid
assert!(BucketSize::milliseconds(0).is_err());

Implementations§

Source§

impl BucketSize

Source

pub fn as_milliseconds(self) -> u64

Return bucket-coalescing interval in milliseconds.

Source

pub fn milliseconds(value: u64) -> Result<Self, TrypemaError>

Create a bucket size expressed in milliseconds.

Source

pub fn milliseconds_or_panic(value: u64) -> Self

Create a bucket size expressed in milliseconds.

§Panics

Panics when value is zero.

Source

pub fn seconds(value: u64) -> Result<Self, TrypemaError>

Create a bucket size expressed in seconds.

Source

pub fn seconds_or_panic(value: u64) -> Self

Create a bucket size expressed in seconds.

§Panics

Panics when value is zero or conversion overflows.

Source

pub fn minutes(value: u64) -> Result<Self, TrypemaError>

Create a bucket size expressed in minutes.

Source

pub fn minutes_or_panic(value: u64) -> Self

Create a bucket size expressed in minutes.

§Panics

Panics when value is zero or conversion overflows.

Source

pub fn hours(value: u64) -> Result<Self, TrypemaError>

Create a bucket size expressed in hours.

Source

pub fn hours_or_panic(value: u64) -> Self

Create a bucket size expressed in hours.

§Panics

Panics when value is zero or conversion overflows.

Source

pub fn days(value: u64) -> Result<Self, TrypemaError>

Create a bucket size expressed in days.

Source

pub fn days_or_panic(value: u64) -> Self

Create a bucket size expressed in days.

§Panics

Panics when value is zero or conversion overflows.

Source

pub fn weeks(value: u64) -> Result<Self, TrypemaError>

Create a bucket size expressed in weeks.

Source

pub fn weeks_or_panic(value: u64) -> Self

Create a bucket size expressed in weeks.

§Panics

Panics when value is zero or conversion overflows.

Source

pub fn months(value: u64) -> Result<Self, TrypemaError>

Create a bucket size expressed in 30-day months.

Source

pub fn months_or_panic(value: u64) -> Self

Create a bucket size expressed in 30-day months.

§Panics

Panics when value is zero or conversion overflows.

Trait Implementations§

Source§

impl Clone for BucketSize

Source§

fn clone(&self) -> BucketSize

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for BucketSize

Source§

impl Debug for BucketSize

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BucketSize

Source§

fn default() -> Self

Returns a rate group size of 100 ms.

Source§

impl PartialEq for BucketSize

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for BucketSize

Source§

fn partial_cmp(&self, other: &BucketSize) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for BucketSize

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more