Struct SensorOptionsBuilder 

pub struct SensorOptionsBuilder<'a> { /* private fields */ }

Fluent builder for SensorOptions.

Self::new takes no parameters, every parameter has a fluent setter, and Self::build validates the mandatory ones — returning Error::LocalIllegalArgument if they were not set.

Implementations

impl<'a> SensorOptionsBuilder<'a>

pub fn new() -> Self

Creates a builder with every mandatory parameter unset and every other parameter at the value Java passes on the caller’s behalf.

pub fn set_name(self, name: &'a str) -> Self

Sets SensorOptions::name, a mandatory parameter: Self::build returns an error if it was not set.

Arguments

• name - the sensor’s unique name

Returns

This builder, for chaining.

pub fn set_config(self, config: Option<Arc<MetricConfig>>) -> Self

Sets SensorOptions::config.

Arguments

• config - the sensor’s default config, None for the registry’s

Returns

This builder, for chaining.

pub fn set_inactive_sensor_expiration_time_seconds( self, inactive_sensor_expiration_time_seconds: i64, ) -> Self

Sets SensorOptions::inactive_sensor_expiration_time_seconds.

Arguments

• inactive_sensor_expiration_time_seconds - how long the sensor may go without a recording before it can be removed

Returns

This builder, for chaining.

pub fn set_recording_level(self, recording_level: RecordingLevel) -> Self

Sets SensorOptions::recording_level.

Arguments

• recording_level - the sensor’s recording level

Returns

This builder, for chaining.

pub fn set_parents(self, parents: &'a [Arc<Sensor>]) -> Self

Sets SensorOptions::parents.

Arguments

• parents - the parent sensors

Returns

This builder, for chaining.

pub fn build(self) -> Result<SensorOptions<'a>, Error>

Returns the built options.

The mandatory parameters are validated here rather than being named in the constructor, so a later Java version that makes one of them optional changes the set this accepts instead of adding a second constructor. Today there is one mandatory set: name.

Errors

Returns Error::LocalIllegalArgument naming the first parameter of that set which was not given a setter call. Only presence is checked here; semantic validation belongs to the method the options are passed to.

Trait Implementations

impl<'a> Debug for SensorOptionsBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for SensorOptionsBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.