Struct goodmetrics::metrics_factory::MetricsFactory

pub struct MetricsFactory<TMetricsAllocator, TSink> { /* private fields */ }

Implementations

impl<TMetricsAllocator, TSink> MetricsFactory<TMetricsAllocator, TSink>

pub fn disable(&mut self)

impl<TMetricsAllocator, TSink> MetricsFactory<TMetricsAllocator, TSink>where
    TMetricsAllocator: Default,

pub fn new(sink: TSink) -> Self

pub fn new_with_behaviors(sink: TSink, behaviors: &[MetricsBehavior]) -> Self

pub fn new_with_allocator(
    sink: TSink,
    behaviors: &[MetricsBehavior],
    allocator: TMetricsAllocator
) -> Self

Trait Implementations

impl<TMetricsAllocator, TSink> Clone for MetricsFactory<TMetricsAllocator, TSink>where
    TSink: Clone,
    TMetricsAllocator: Clone,

Cloning a MetricsFactory is not cheap. You should cache it per-thread rather than doing so to work around visibility issues.

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TMetricsAllocator, TSink> Default for MetricsFactory<TMetricsAllocator, TSink>where
    TSink: Default,
    TMetricsAllocator: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<'a, TMetricsRef, TMetricsAllocator, TSink> RecordingScope<'a, TMetricsRef> for MetricsFactory<TMetricsAllocator, TSink>where
    TMetricsRef: MetricsRef + 'a,
    TSink: Sink<TMetricsRef>,
    TMetricsAllocator: MetricsAllocator<'a, TMetricsRef> + Default,

unsafe fn create_new_raw_metrics(
    &'a self,
    metrics_name: impl Into<Name>
) -> TMetricsRef

Safety

You should strongly consider using record_scope() instead. You must emit() the returned instance through this MetricsFactory instance or else you may leak memory, depending on the semantics of your allocator.

fn record_scope(
    &'a self,
    scope_name: impl Into<Name>
) -> ReturningRef<'a, TMetricsRef, Self>

fn record_scope_with_behavior(
    &'a self,
    scope_name: impl Into<Name>,
    behavior: MetricsBehavior
) -> ReturningRef<'a, TMetricsRef, Self>

fn emit(&self, metrics: TMetricsRef)

impl<'a, TMetricsRef, TMetricsAllocator, TSink> ReturnTarget<'a, TMetricsRef> for MetricsFactory<TMetricsAllocator, TSink>where
    TMetricsRef: MetricsRef + 'a,
    TMetricsAllocator: MetricsAllocator<'a, TMetricsRef> + Default,
    TSink: Sink<TMetricsRef>,

fn return_referent(&self, to_return: TMetricsRef)