Struct prometheus::TextEncoder

pub struct TextEncoder;

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

Implementations

impl TextEncoder

pub fn new() -> TextEncoder

Create a new text encoder.

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.

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

impl Debug for TextEncoder

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

Formats the value using the given formatter.

impl Default for TextEncoder

fn default() -> TextEncoder

Returns the “default value” for a type.

impl Encoder for TextEncoder

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. It returns the number of bytes written and any error encountered. This function does not perform checks on the content of the metric and label names, i.e. invalid metric or label names will result in invalid text format output.

fn format_type(&self) -> &str

format_type returns target format.