Enum glean::ErrorType

#[repr(C)]
pub enum ErrorType {
    InvalidValue = 0,
    InvalidLabel = 1,
    InvalidState = 2,
    InvalidOverflow = 3,
}

The possible error types for metric recording.

Note: the cases in this enum must be kept in sync with the ones in the platform-specific code (e.g. ErrorType.kt) and with the metrics in the registry files.

Variants

InvalidValue = 0

For when the value to be recorded does not match the metric-specific restrictions

InvalidLabel = 1

For when the label of a labeled metric does not match the restrictions

InvalidState = 2

For when the metric caught an invalid state while recording

InvalidOverflow = 3

For when the value to be recorded overflows the metric-specific upper range

Implementations

impl ErrorType

pub fn as_str(&self) -> &'static str

The error type’s metric id

pub fn iter() -> impl Iterator<Item = ErrorType>

Return an iterator over all possible error types.

let errors = ErrorType::iter();
let all_errors = errors.collect::<Vec<_>>();
assert_eq!(4, all_errors.len());

Trait Implementations

impl Clone for ErrorType

fn clone(&self) -> ErrorType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for ErrorType

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<ErrorType, Error>

impl Debug for ErrorType

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for ErrorType

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: ErrorType) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<ErrorType, Error>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: ErrorType, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<ErrorType, Error>

Read a rust value from a buffer, received over the FFI in serialized form.

const TYPE_ID_META: MetadataBuffer = _

Type ID metadata, serialized into a [MetadataBuffer].

impl<UT> Lift<UT> for ErrorType

type FfiType = <ErrorType as FfiConverter<UT>>::FfiType

fn try_lift(v: <ErrorType as Lift<UT>>::FfiType) -> Result<ErrorType, Error>

fn try_read(buf: &mut &[u8]) -> Result<ErrorType, Error>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for ErrorType

type LiftType = ErrorType

impl<UT> LiftReturn<UT> for ErrorType

type ReturnType = <ErrorType as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return( v: <ErrorType as LiftReturn<UT>>::ReturnType, ) -> Result<ErrorType, Error>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for ErrorType

type FfiType = <ErrorType as FfiConverter<UT>>::FfiType

fn lower(obj: ErrorType) -> <ErrorType as Lower<UT>>::FfiType

fn write(obj: ErrorType, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for ErrorType

fn lower_error(obj: ErrorType) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for ErrorType

type ReturnType = <ErrorType as Lower<UT>>::FfiType

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

fn lower_return( v: ErrorType, ) -> Result<<ErrorType as LowerReturn<UT>>::ReturnType, RustCallError>

Lower the return value from an scaffolding call

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

Lower the return value for failed argument lifts

impl PartialEq for ErrorType

fn eq(&self, other: &ErrorType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<i32> for ErrorType

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<ErrorType, <ErrorType as TryFrom<i32>>::Error>

Performs the conversion.

impl<UT> TypeId<UT> for ErrorType

const TYPE_ID_META: MetadataBuffer = _

impl Copy for ErrorType

impl Eq for ErrorType

impl StructuralPartialEq for ErrorType