Struct prometheus::TextEncoder

source ·
pub struct TextEncoder;
Expand description

An implementation of an Encoder that converts a MetricFamily proto message into text format.

Implementations§

source§

impl TextEncoder

source

pub fn new() -> TextEncoder

Create a new text encoder.

source

pub fn encode_utf8( &self, metric_families: &[MetricFamily], buf: &mut String, ) -> Result<()>

Appends metrics to a given String buffer.

This is a convenience wrapper around <TextEncoder as Encoder>::encode.

source

pub fn encode_to_string( &self, metric_families: &[MetricFamily], ) -> Result<String>

Converts metrics to String.

This is a convenience wrapper around <TextEncoder as Encoder>::encode.

Trait Implementations§

source§

impl Debug for TextEncoder

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for TextEncoder

source§

fn default() -> TextEncoder

Returns the “default value” for a type. Read more
source§

impl Encoder for TextEncoder

source§

fn encode<W: Write>( &self, metric_families: &[MetricFamily], writer: &mut W, ) -> Result<()>

encode converts a slice of MetricFamily proto messages into target format and writes the resulting lines to writer. This function does not perform checks on the content of the metrics and label names, i.e. invalid metrics or label names will result in invalid text format output.
source§

fn format_type(&self) -> &str

format_type returns target format.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.