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
impl TextEncoder
sourcepub fn new() -> TextEncoder
pub fn new() -> TextEncoder
Create a new text encoder.
sourcepub fn encode_utf8(
&self,
metric_families: &[MetricFamily],
buf: &mut String
) -> Result<()>
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
.
sourcepub fn encode_to_string(
&self,
metric_families: &[MetricFamily]
) -> Result<String>
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
impl Debug for TextEncoder
source§impl Default for TextEncoder
impl Default for TextEncoder
source§fn default() -> TextEncoder
fn default() -> TextEncoder
Returns the “default value” for a type. Read more
source§impl Encoder for TextEncoder
impl Encoder for TextEncoder
source§fn encode<W: Write>(
&self,
metric_families: &[MetricFamily],
writer: &mut W
) -> Result<()>
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
fn format_type(&self) -> &str
format_type
returns target format.Auto Trait Implementations§
impl RefUnwindSafe for TextEncoder
impl Send for TextEncoder
impl Sync for TextEncoder
impl Unpin for TextEncoder
impl UnwindSafe for TextEncoder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more