Struct MetricEventBuilder

pub struct MetricEventBuilder { /* private fields */ }

MetricEventBuilder allows for a chained construction of MetricEvent objects.

Implementations

impl MetricEventBuilder

pub fn with_event_code(self, event_code: u32) -> MetricEventBuilder

Appends the provided event_code to the event_codes list.

Examples

assert_eq!(MetricEvent::builder(6).with_event_code(10).as_event().event_codes, vec![10]);

pub fn with_event_codes<Codes: AsEventCodes>( self, event_codes: Codes, ) -> MetricEventBuilder

Overrides the list of event_codes with the provided event_codes.

Examples

assert_eq!(
    MetricEvent::builder(7).with_event_codes([1, 2, 3]).as_event().event_codes,
    vec![1,2,3]);

pub fn with_event_code_at( self, index: usize, event_code: u32, ) -> MetricEventBuilder

Writes an event_code to a particular index. This method is useful when not assigning event codes in order.

Examples

assert_eq!(
    MetricEvent::builder(8).with_event_code_at(1, 10).as_event().event_codes,
    vec![0, 10]);

Panics

Panics if the value is greater than or equal to 5.

pub fn build(self, payload: MetricEventPayload) -> MetricEvent

Constructs a MetricEvent with the provided MetricEventPayload.

Examples

let payload = MetricEventPayload::Event(fidl_fuchsia_cobalt::Event);
assert_eq!(MetricEvent::builder(10).build(payload.clone()).payload, payload);

pub fn as_occurrence(self, count: u64) -> MetricEvent

Constructs a MetricEvent with a payload type of MetricEventPayload::Count.

Examples

asert_eq!(
    MetricEvent::builder(11).as_occurrence(10).payload,
    MetricEventPayload::Event(fidl_fuchsia_cobalt::Count(10)));

pub fn as_integer(self, integer_value: i64) -> MetricEvent

Constructs a MetricEvent with a payload type of MetricEventPayload::IntegerValue.

Examples

asert_eq!(
    MetricEvent::builder(12).as_integer(5).payload,
    MetricEventPayload::IntegerValue(5)));

pub fn as_integer_histogram( self, histogram: Vec<HistogramBucket>, ) -> MetricEvent

Constructs a MetricEvent with a payload type of MetricEventPayload::Histogram.

Examples

let histogram = vec![HistogramBucket { index: 0, count: 1 }];
asert_eq!(
    MetricEvent::builder(17).as_int_histogram(histogram.clone()).payload,
    MetricEventPayload::Histogram(histogram));

pub fn as_string<S: Into<String>>(self, string: S) -> MetricEvent

Constructs a MetricEvent with a payload type of MetricEventPayload::StringValue.

Examples

asert_eq!(
    MetricEvent::builder(17).as_string("test").payload,
    MetricEventPayload::StringValue("test".to_string()));

Trait Implementations

impl Clone for MetricEventBuilder

fn clone(&self) -> MetricEventBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricEventBuilder

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

Formats the value using the given formatter.

impl Default for MetricEventBuilder

fn default() -> MetricEventBuilder

Returns the “default value” for a type.