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

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

Implementations§

source§

impl<B> Encoder<B>
where B: MutableBuffer,

source

pub fn new(buf: B) -> Self

Create a new Encoder from the provided buffer.

source

pub fn inner(&self) -> &B

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

source

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 a [tracing::Event] to the buffer as a record.

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

source

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

Writes a Record to the buffer.

source

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

Writes an argument with this encoder.

Trait Implementations§

source§

impl<B: MutableBuffer> Visit for Encoder<B>

source§

fn record_debug(&mut self, field: &Field, value: &dyn Debug)

Visit a value implementing fmt::Debug.
source§

fn record_str(&mut self, field: &Field, value: &str)

Visit a string value.
source§

fn record_i64(&mut self, field: &Field, value: i64)

Visit a signed 64-bit integer value.
source§

fn record_u64(&mut self, field: &Field, value: u64)

Visit an unsigned 64-bit integer value.
source§

fn record_bool(&mut self, field: &Field, value: bool)

Visit a boolean value.
§

fn record_f64(&mut self, field: &Field, value: f64)

Visit a double-precision floating point value.
§

fn record_i128(&mut self, field: &Field, value: i128)

Visit a signed 128-bit integer value.
§

fn record_u128(&mut self, field: &Field, value: u128)

Visit an unsigned 128-bit integer value.
§

fn record_error(&mut self, field: &Field, value: &(dyn Error + 'static))

Records a type implementing Error.

Auto Trait Implementations§

§

impl<B> Freeze for Encoder<B>
where B: Freeze,

§

impl<B> RefUnwindSafe for Encoder<B>
where B: RefUnwindSafe,

§

impl<B> Send for Encoder<B>
where B: Send,

§

impl<B> Sync for Encoder<B>
where B: Sync,

§

impl<B> Unpin for Encoder<B>
where B: Unpin,

§

impl<B> UnwindSafe for Encoder<B>
where B: UnwindSafe,

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
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more