Encoder

Struct Encoder 

Source
pub struct Encoder { /* private fields */ }
Expand description

The Encoder struct provides methods for packing values that implement the Packer trait.

§Examples

use antelope::serializer::{Encoder, Packer};

let mut encoder = Encoder::new(4);
let value = 123u32;

let bytes_written = value.pack(&mut encoder);
assert_eq!(bytes_written, 4);

let packed_bytes = encoder.get_bytes();
assert_eq!(packed_bytes, [123, 0, 0, 0]);

Implementations§

Source§

impl Encoder

Source

pub fn new(size: usize) -> Self

Constructs a new Encoder with the given initial capacity.

§Arguments
  • size - The initial capacity of the encoder in bytes.
§Returns

A new Encoder instance with the given initial capacity.

Source

pub fn get_bytes(&self) -> &[u8]

Returns the packed bytes of this encoder as a byte array.

§Returns

A reference to the packed bytes of this encoder as a byte array.

Source

pub fn get_size(&self) -> usize

Returns the number of packed bytes in this encoder.

§Returns

The number of packed bytes in this encoder.

Source

pub fn alloc(&mut self, size: usize) -> &mut [u8]

Allocates space in this encoder for packing a value of the given size.

§Arguments
  • size - The number of bytes to allocate in this encoder.
§Returns

A mutable reference to the allocated

Source

pub fn pack<T: Packer>(value: &T) -> Vec<u8>

Packs the given value using the encoder

§Arguments
  • value - The value to be packed
§Examples
use antelope::serializer::{Encoder, Packer};

let data = Encoder::pack(&1234u32);
assert_eq!(data, vec![210, 4, 0, 0]);

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> Instrument for T

Source§

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

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

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.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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