Enum serde_prometheus::Error

pub enum Error {
    Serde {
        context: String,
    },
    Io {
        context: Error,
    },
    NoMetricName,
    MapKeyMustBeString,
    LabelsMustBeMap,
    LabelKeyNotInFormat,
    LabelValueMustBeString,
    UnsupportedValue {
        kind: String,
    },
    MetricNameMustBeUtf8 {
        source: Utf8Error,
    },
    MetricNameNotInFormat {
        kind: String,
    },
    MetricValueMustBeNumeric {
        kind: String,
    },
    UnknownHint,
    InvalidLabel,
    InvalidModifier,
}

Variants

Serde

An error thrown by the serde::Serialize trait on a type. This error is thrown from outside of this crate, most likely from within serde for a std library type.

Fields of Serde

context: String

Io

A stdlib io error occurred whilst writing the serialized data out.

Fields of Io

context: Error

NoMetricName

The value attempting to be serialised does not belong to any metric, try serialising this value as a struct member or in a map.

MapKeyMustBeString

Thrown when serializing in a map that doesn't contain string keys.

LabelsMustBeMap

Caused by attempting to serialize labels from a format other than a map.

LabelKeyNotInFormat

Thrown when attempting to serialize a label which doesn't conform to the format defined here.

LabelValueMustBeString

Thrown when serializing a label map that doesn't use string values.

UnsupportedValue

Thrown when the main serializer encounters a value that isn't supported, value can only contain maps that contain numbers, or other structs that when followed, only lead to numbers.

Fields of UnsupportedValue

kind: String

MetricNameMustBeUtf8

UTF-8 error when attempting to serialize strings passed in by client.

Fields of MetricNameMustBeUtf8

source: Utf8Error

MetricNameNotInFormat

Thrown when attempting to serialize a metric name which doesn't conform to the format defined here.

Fields of MetricNameNotInFormat

kind: String

MetricValueMustBeNumeric

Thrown when attempting to serialize a metric value that isn't a stdlib numeric type.

Fields of MetricValueMustBeNumeric

kind: String

UnknownHint

Attempted to 'hint' that a value is a type that isn't defined in crate::TypeHint

InvalidLabel

Labels, when being passed to the serializer, must be in the format of key1=val1,key2=val2

InvalidModifier

A key modifier was passed that isn't recognised. See crate::Serializer::serialize_newtype_struct for recognised modifiers.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error where
    Self: Debug + Display, 

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

impl Error for Error

fn custom<T>(msg: T) -> Self where
    T: Display, 

Used when a Serialize implementation encounters any error while serializing a type.

impl ErrorCompat for Error

fn backtrace(&self) -> Option<&Backtrace>

Returns a Backtrace that may be printed.

impl From<Error> for Error

fn from(context: Error) -> Self

Performs the conversion.