Struct tokio_cadence::builder::Builder

pub struct Builder<T, S> { /* private fields */ }

Builder allows you to override various default parameter values before creating an instance of the desired Metric Sink.

Implementations

impl<T, S> Builder<T, S>

pub fn queue_cap(&mut self, queue_cap: usize) -> &mut Self

Sets the maximum metric queue capacity (default: DEFAULT_QUEUE_CAPACITY).

pub fn buf_size(&mut self, buf_size: usize) -> &mut Self

Sets the batch buffer size (default: DEFAULT_BATCH_BUF_SIZE).

pub fn max_delay(&mut self, max_delay: Duration) -> &mut Self

Sets the maximum delay before flushing any buffered metrics (default: DEFAULT_MAX_BATCH_DELAY).

impl<T: ToSocketAddrs> Builder<T, UdpSocket>

pub fn build( self ) -> MetricResult<(TokioBatchUdpMetricSink, Pin<Box<dyn Future<Output = ()> + Send + Sync + 'static>>)>

Creates a customized instance of the TokioBatchUdpMetricSink.

Errors

Returns an error when unable to resolve the configured host address, or when the configured queue capacity is 0.

impl<T: AsRef<Path> + Send + Sync + Unpin + 'static> Builder<T, UnixDatagram>

pub fn build( self ) -> MetricResult<(TokioBatchUnixMetricSink, Pin<Box<dyn Future<Output = ()> + Send + Sync + 'static>>)>

Creates a customized instance of the TokioBatchUnixMetricSink.

Errors

Returns an error when the configured queue capacity is 0.

Trait Implementations

impl<T: Debug, S: Debug> Debug for Builder<T, S>

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

Formats the value using the given formatter.