Struct Encoder

pub struct Encoder<B> { /* private fields */ }

An Encoder wraps any value implementing MutableBuffer and writes diagnostic stream records into it.

Implementations

impl<B> Encoder<B>

where B: MutableBuffer,

pub fn new(buf: B, options: EncoderOpts) -> Self

Create a new Encoder from the provided buffer.

pub fn inner(&self) -> &B

Returns a reference to the underlying buffer being used for encoding.

pub fn take(self) -> B

Returns a reference to the underlying buffer being used for encoding.

pub fn write_event<'a, E, MS, T>( &mut self, params: WriteEventParams<'a, E, T, MS>, ) -> Result<(), EncodingError>

where E: RecordEvent, MS: Iterator<Item = &'a Metatag>, T: AsRef<str>,

Writes an event to to the buffer as a record.

Fails if there is insufficient space in the buffer for encoding.

pub fn write_record<R>(&mut self, record: R) -> Result<(), EncodingError>

where R: RecordFields,

Writes a Record to the buffer.

pub fn write_raw_argument( &mut self, name: &str, value: impl WriteArgumentValue<B>, ) -> Result<(), EncodingError>

Writes an argument with this encoder with the given name and value.

pub fn write_argument<'a>( &mut self, argument: impl Borrow<Argument<'a>>, ) -> Result<(), EncodingError>

Writes an argument with this encoder.