Struct dogstatsd::OptionsBuilder

pub struct OptionsBuilder { /* private fields */ }

Struct that allows build an Options for available for the Dogstatsd client.

Implementations

impl OptionsBuilder

pub fn new() -> Self

Create a new OptionsBuilder struct.

Examples

  use dogstatsd::OptionsBuilder;

  let options_builder = OptionsBuilder::new();

pub fn from_addr(&mut self, from_addr: String) -> &mut OptionsBuilder

Will allow the builder to generate an Options struct with the provided value.

Examples

  use dogstatsd::OptionsBuilder;

  let options_builder = OptionsBuilder::new().from_addr(String::from("127.0.0.1:9000"));

pub fn to_addr(&mut self, to_addr: String) -> &mut OptionsBuilder

Will allow the builder to generate an Options struct with the provided value.

Examples

  use dogstatsd::OptionsBuilder;

  let options_builder = OptionsBuilder::new().to_addr(String::from("127.0.0.1:9001"));

pub fn namespace(&mut self, namespace: String) -> &mut OptionsBuilder

Will allow the builder to generate an Options struct with the provided value.

Examples

  use dogstatsd::OptionsBuilder;

  let options_builder = OptionsBuilder::new().namespace(String::from("mynamespace"));

pub fn default_tag(&mut self, default_tag: String) -> &mut OptionsBuilder

Will allow the builder to generate an Options struct with the provided value. Can be called multiple times to add multiple default_tags to the Options.

Examples

  use dogstatsd::OptionsBuilder;

  let options_builder = OptionsBuilder::new().default_tag(String::from("tag1:tav1val")).default_tag(String::from("tag2:tag2val"));

pub fn socket_path( &mut self, socket_path: Option<String> ) -> &mut OptionsBuilder

Will allow the builder to generate an Options struct with the provided value.

Examples

  use dogstatsd::OptionsBuilder;

  let options_builder = OptionsBuilder::new().default_tag(String::from("tag1:tav1val")).default_tag(String::from("tag2:tav2val"));

pub fn batching_options( &mut self, batching_options: BatchingOptions ) -> &mut OptionsBuilder

Will allow the builder to generate an Options struct with the provided value.

Examples

  use dogstatsd::{ OptionsBuilder, BatchingOptions };
  use std::time::Duration;

  let options_builder = OptionsBuilder::new().batching_options(BatchingOptions { max_buffer_size: 8000, max_time: Duration::from_millis(3000), max_retry_attempts: 3, initial_retry_delay: 10 });

pub fn build(&self) -> Options

Will construct an Options with all of the provided values and fall back to the default values if they aren’t provided.

Examples

  use dogstatsd::OptionsBuilder;
  use dogstatsd::Options;

  let options = OptionsBuilder::new().namespace(String::from("mynamespace")).default_tag(String::from("tag1:tav1val")).build();

  assert_eq!(
      Options {
          from_addr: "0.0.0.0:0".into(),
          to_addr: "127.0.0.1:8125".into(),
          namespace: String::from("mynamespace"),
          default_tags: vec!(String::from("tag1:tav1val")),
          socket_path: None,
          batching_options: None,
      },
      options
  )

Trait Implementations

impl Debug for OptionsBuilder

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

Formats the value using the given formatter.

impl Default for OptionsBuilder

fn default() -> OptionsBuilder

Returns the “default value” for a type.