Enum EncodableField

pub enum EncodableField<'a> {
    Primitive(EncodablePrimitive<'a>),
    Struct(Vec<EncodableField<'a>>),
}

Expand description

The EncodableField enum defines encodable fields, which may be a primitive or struct.

Each EncodableField represents either a primitive value or a collection of values (a struct). The encoding process for EncodableField supports nesting, allowing for complex hierarchical data structures to be serialized.

Variants§

Primitive(EncodablePrimitive<'a>)

Represents a primitive value

For the full supported list please see EncodablePrimitive

Struct(Vec<EncodableField<'a>>)

Represents a struct like field structure.

Note that this is a recursive enum type.

Implementations§

impl EncodableField<'_>

pub fn encode(&self, dst: &mut [u8], offset: usize) -> Result<usize, Error>

The encode method serializes a field into the destination buffer dst, starting at the provided offset. If the field is a structure, it recursively encodes each contained field. If the buffer is too small or encoding fails, the method returns an error.

Trait Implementations§

impl<'a> Debug for EncodableField<'a>

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

Formats the value using the given formatter. Read more

impl<'a> From<Inner<'a, false, 1, 1, 255>> for EncodableField<'a>

fn from(v: Inner<'a, false, 1, 1, 255>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Inner<'a, false, 1, 1, 32>> for EncodableField<'a>

fn from(v: Inner<'a, false, 1, 1, 32>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Inner<'a, false, 1, 2, binary_codec_sv2::::datatypes::non_copy_data_types::B064K::{constant#3}>> for EncodableField<'a>

fn from( v: Inner<'a, false, 1, 2, binary_codec_sv2::::datatypes::non_copy_data_types::B064K::{constant#3}>, ) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Inner<'a, false, 1, 3, binary_codec_sv2::::datatypes::non_copy_data_types::B016M::{constant#3}>> for EncodableField<'a>

fn from( v: Inner<'a, false, 1, 3, binary_codec_sv2::::datatypes::non_copy_data_types::B016M::{constant#3}>, ) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Inner<'a, true, 32, 0, 0>> for EncodableField<'a>

fn from(v: Inner<'a, true, 32, 0, 0>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Inner<'a, true, 4, 0, 0>> for EncodableField<'a>

fn from(v: Inner<'a, true, 4, 0, 0>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Inner<'a, true, 64, 0, 0>> for EncodableField<'a>

fn from(v: Inner<'a, true, 64, 0, 0>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq0255<'a, Inner<'a, false, 1, 1, 255>>> for EncodableField<'a>

fn from(v: Seq0255<'_, Inner<'a, false, 1, 1, 255>>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq0255<'a, Inner<'a, false, 1, 2, binary_codec_sv2::::datatypes::non_copy_data_types::B064K::{constant#3}>>> for EncodableField<'a>

fn from( v: Seq0255<'_, Inner<'a, false, 1, 2, binary_codec_sv2::::datatypes::non_copy_data_types::B064K::{constant#3}>>, ) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq0255<'a, Inner<'a, false, 1, 3, binary_codec_sv2::::datatypes::non_copy_data_types::B016M::{constant#3}>>> for EncodableField<'a>

fn from( v: Seq0255<'_, Inner<'a, false, 1, 3, binary_codec_sv2::::datatypes::non_copy_data_types::B016M::{constant#3}>>, ) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq0255<'a, Inner<'a, true, 32, 0, 0>>> for EncodableField<'a>

fn from(v: Seq0255<'_, Inner<'a, true, 32, 0, 0>>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq0255<'a, Inner<'a, true, 64, 0, 0>>> for EncodableField<'a>

fn from(v: Seq0255<'_, Inner<'a, true, 64, 0, 0>>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq0255<'a, U24>> for EncodableField<'a>

fn from(v: Seq0255<'_, U24>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq0255<'a, bool>> for EncodableField<'a>

fn from(v: Seq0255<'_, bool>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq0255<'a, u16>> for EncodableField<'a>

fn from(v: Seq0255<'_, u16>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq0255<'a, u32>> for EncodableField<'a>

fn from(v: Seq0255<'_, u32>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq0255<'a, u64>> for EncodableField<'a>

fn from(v: Seq0255<'_, u64>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq0255<'a, u8>> for EncodableField<'a>

fn from(v: Seq0255<'_, u8>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq064K<'a, Inner<'a, false, 1, 1, 255>>> for EncodableField<'a>

fn from(v: Seq064K<'a, Inner<'a, false, 1, 1, 255>>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq064K<'a, Inner<'a, false, 1, 2, binary_codec_sv2::::datatypes::non_copy_data_types::B064K::{constant#3}>>> for EncodableField<'a>

fn from( v: Seq064K<'a, Inner<'a, false, 1, 2, binary_codec_sv2::::datatypes::non_copy_data_types::B064K::{constant#3}>>, ) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq064K<'a, Inner<'a, false, 1, 3, binary_codec_sv2::::datatypes::non_copy_data_types::B016M::{constant#3}>>> for EncodableField<'a>

fn from( v: Seq064K<'a, Inner<'a, false, 1, 3, binary_codec_sv2::::datatypes::non_copy_data_types::B016M::{constant#3}>>, ) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq064K<'a, Inner<'a, true, 32, 0, 0>>> for EncodableField<'a>

fn from(v: Seq064K<'a, Inner<'a, true, 32, 0, 0>>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq064K<'a, Inner<'a, true, 64, 0, 0>>> for EncodableField<'a>

fn from(v: Seq064K<'a, Inner<'a, true, 64, 0, 0>>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq064K<'a, U24>> for EncodableField<'a>

fn from(v: Seq064K<'a, U24>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq064K<'a, bool>> for EncodableField<'a>

fn from(v: Seq064K<'a, bool>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq064K<'a, u16>> for EncodableField<'a>

fn from(v: Seq064K<'a, u16>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq064K<'a, u32>> for EncodableField<'a>

fn from(v: Seq064K<'a, u32>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq064K<'a, u64>> for EncodableField<'a>

fn from(v: Seq064K<'a, u64>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Seq064K<'a, u8>> for EncodableField<'a>

fn from(v: Seq064K<'a, u8>) -> EncodableField<'a>

Converts to this type from the input type.

impl From<Slice> for EncodableField<'_>

fn from(_v: Slice) -> EncodableField<'_>

Converts to this type from the input type.

impl<'a> From<Sv2Option<'a, Inner<'a, false, 1, 1, 255>>> for EncodableField<'a>

fn from(v: Sv2Option<'_, Inner<'a, false, 1, 1, 255>>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Sv2Option<'a, Inner<'a, false, 1, 2, binary_codec_sv2::::datatypes::non_copy_data_types::B064K::{constant#3}>>> for EncodableField<'a>

fn from( v: Sv2Option<'_, Inner<'a, false, 1, 2, binary_codec_sv2::::datatypes::non_copy_data_types::B064K::{constant#3}>>, ) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Sv2Option<'a, Inner<'a, false, 1, 3, binary_codec_sv2::::datatypes::non_copy_data_types::B016M::{constant#3}>>> for EncodableField<'a>

fn from( v: Sv2Option<'_, Inner<'a, false, 1, 3, binary_codec_sv2::::datatypes::non_copy_data_types::B016M::{constant#3}>>, ) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Sv2Option<'a, Inner<'a, true, 32, 0, 0>>> for EncodableField<'a>

fn from(v: Sv2Option<'_, Inner<'a, true, 32, 0, 0>>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Sv2Option<'a, Inner<'a, true, 64, 0, 0>>> for EncodableField<'a>

fn from(v: Sv2Option<'_, Inner<'a, true, 64, 0, 0>>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Sv2Option<'a, U24>> for EncodableField<'a>

fn from(v: Sv2Option<'_, U24>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Sv2Option<'a, bool>> for EncodableField<'a>

fn from(v: Sv2Option<'_, bool>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Sv2Option<'a, u16>> for EncodableField<'a>

fn from(v: Sv2Option<'_, u16>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Sv2Option<'a, u32>> for EncodableField<'a>

fn from(v: Sv2Option<'_, u32>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Sv2Option<'a, u64>> for EncodableField<'a>

fn from(v: Sv2Option<'_, u64>) -> EncodableField<'a>

Converts to this type from the input type.

impl<'a> From<Sv2Option<'a, u8>> for EncodableField<'a>

fn from(v: Sv2Option<'_, u8>) -> EncodableField<'a>

Converts to this type from the input type.

impl From<U24> for EncodableField<'_>

fn from(v: U24) -> EncodableField<'_>

Converts to this type from the input type.

impl From<Vec<u8>> for EncodableField<'_>

fn from(_v: Vec<u8>) -> EncodableField<'_>

Converts to this type from the input type.

impl From<bool> for EncodableField<'_>

fn from(v: bool) -> EncodableField<'_>

Converts to this type from the input type.

impl From<f32> for EncodableField<'_>

fn from(v: f32) -> EncodableField<'_>

Converts to this type from the input type.

impl From<u16> for EncodableField<'_>

fn from(v: u16) -> EncodableField<'_>

Converts to this type from the input type.

impl From<u32> for EncodableField<'_>

fn from(v: u32) -> EncodableField<'_>

Converts to this type from the input type.

impl From<u64> for EncodableField<'_>

fn from(v: u64) -> EncodableField<'_>

Converts to this type from the input type.

impl From<u8> for EncodableField<'_>

fn from(v: u8) -> EncodableField<'_>

Converts to this type from the input type.

impl GetSize for EncodableField<'_>

fn get_size(&self) -> usize

get_size returns total size of the type in bytes.

impl<'a> TryFrom<EncodableField<'a>> for U24

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: EncodableField<'a>, ) -> Result<U24, <U24 as TryFrom<EncodableField<'a>>>::Error>

Performs the conversion.

Auto Trait Implementations§

impl<'a> Freeze for EncodableField<'a>

impl<'a> RefUnwindSafe for EncodableField<'a>

impl<'a> Send for EncodableField<'a>

impl<'a> Sync for EncodableField<'a>

impl<'a> Unpin for EncodableField<'a>

impl<'a> !UnwindSafe for EncodableField<'a>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<'a, T> Encodable for T
where T: Into<EncodableField<'a>>,

fn to_bytes(self, dst: &mut [u8]) -> Result<usize, Error>

Encodes the object into the provided byte slice. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.