Struct CardinalityLimit

pub struct CardinalityLimit {
    pub id: String,
    pub passive: bool,
    pub report: bool,
    pub window: SlidingWindow,
    pub limit: u32,
    pub scope: CardinalityScope,
    pub namespace: Option<MetricNamespace>,
}

A cardinality limit.

Fields

id: String

Unique identifier of the cardinality limit.

passive: bool

Whether this is a passive limit.

Passive limits are tracked separately to normal limits and are not enforced, but still evaluated.

report: bool

If true additional reporting of cardinality is enabled.

The cardinality limiter will keep track of every tracked limit and record the current cardinality. The reported data is not per limit but per scope. For example if Self::scope is set to CardinalityScope::Name, the current cardinality for each metric name is reported.

window: SlidingWindow

The sliding window to enforce the cardinality limits in.

limit: u32

The cardinality limit.

scope: CardinalityScope

Scope which the limit applies to.

namespace: Option<MetricNamespace>

Metric namespace the limit applies to.

No namespace means this specific limit is enforced across all namespaces.

Trait Implementations

impl Clone for CardinalityLimit

fn clone(&self) -> CardinalityLimit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CardinalityLimit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CardinalityLimit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CardinalityLimit

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CardinalityLimit

fn cmp(&self, other: &CardinalityLimit) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CardinalityLimit

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

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for CardinalityLimit

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CardinalityLimit

impl StructuralPartialEq for CardinalityLimit