Struct glean_core::metrics::ObjectMetric

impl ObjectMetric

pub fn new(meta: CommonMetricData) -> Self

Creates a new object metric.

pub fn set(&self, value: JsonValue)

Sets to the specified structure.

No additional verification is done. The shape needs to be externally verified.

Arguments

value - the value to set.

pub fn set_string(&self, object: String)

Sets to the specified structure.

Parses the passed JSON string. If it can’t be parsed into a valid object it records an invalid value error.

Note: This does not check the structure. This needs to be done by the wrapper.

Arguments

object - JSON representation of the object to set.

pub fn record_schema_error(&self)

Record an InvalidValue error for this metric.

Only to be used by the RLB.

pub fn test_get_value(&self, ping_name: Option<String>) -> Option<JsonValue>

Test-only API (exported for FFI purposes).

Gets the currently stored value as JSON.

This doesn’t clear the stored value.

pub fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32

Exported for test purposes.

Gets the number of recorded errors for the given metric and error type.

Arguments

error - The type of error
ping_name - represents the optional name of the ping to retrieve the metric for. inner to the first value in send_in_pings.

Returns

The number of errors reported.

Trait Implementations§

impl Clone for ObjectMetric

fn clone(&self) -> ObjectMetric

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for ObjectMetric

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

Formats the value using the given formatter. Read more

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return Read more

impl<UT> LowerReturn<UT> for ObjectMetric

type ReturnType = <Arc<ObjectMetric> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type. Read more

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call Read more

fn handle_failed_lift( error: LiftArgsError ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts Read more

impl MetricType for ObjectMetric

fn meta(&self) -> &CommonMetricDataInternal

Access the stored metadata

fn with_name(&self, _name: String) -> Self
where Self: Sized,

Create a new metric from this with a new name.

fn with_dynamic_label(&self, _label: String) -> Self
where Self: Sized,

Create a new metric from this with a specific label.

fn should_record(&self, glean: &Glean) -> bool

Whether this metric should currently be recorded Read more

impl<UT> TypeId<UT> for ObjectMetric

const TYPE_ID_META: MetadataBuffer = _

Auto Trait Implementations§

impl RefUnwindSafe for ObjectMetric

impl Send for ObjectMetric

impl Sync for ObjectMetric

impl Unpin for ObjectMetric

impl UnwindSafe for ObjectMetric

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<'a, T> MetricIdentifier<'a> for T
where T: MetricType,

fn get_identifiers(&'a self) -> (&'a str, &'a str, Option<&'a str>)

Retrieve the category, name and (maybe) label of the metric

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.