Struct mesh::payload::encoding::ByteField

pub struct ByteField;

A field encoder for u8.

This is separate from VarintField so that the packed format can be a byte array instead of a varint array.

Trait Implementations

impl DescribeField<u8> for ByteField

const FIELD_TYPE: FieldType<'static> = _

The type of the field.

const PACKED_TYPE: Option<&'static str> = _

The type name of the field in a packed context.

impl<'a, R> FieldDecode<'a, u8, R> for ByteField

fn read_field( item: &mut InplaceOption<'_, u8>, reader: FieldReader<'_, '_, R>, ) -> Result<(), Error>

Reads a field into item.

fn default_field(item: &mut InplaceOption<'_, u8>) -> Result<(), Error>

Instantiates item with its default value, if there is one.

fn packed<'p, C>() -> Option<&'p dyn PackedDecode<'a, u8, C>>

where C: CopyExtend<u8>, u8: 'p,

Unless packed()::must_pack() is true, the sequence decoder must detect the encoding (packed or not) and call the appropriate method.

fn wrap_in_sequence() -> bool

Returns whether this field is wrapped in a message when encoded nested in a sequence (such as a repeated field).

fn read_field_in_sequence( item: &mut InplaceOption<'_, T>, reader: FieldReader<'a, '_, R>, ) -> Result<(), Error>

Reads this field that was encoded as part of a sequence, unwrapping it from a message if necessary.

const ENTRY: DecoderEntry<'a, T, R> = _

The table decoder entry for this type, used in types from table::decode.

impl<R> FieldEncode<u8, R> for ByteField

fn write_field(item: u8, writer: FieldWriter<'_, '_, R>)

Writes item as a field.

fn compute_field_size(item: &mut u8, sizer: FieldSizer<'_>)

Computes the size of item as a field.

fn packed<'a>() -> Option<&'a dyn PackedEncode<u8>>

Returns the encoder for writing multiple instances of this field in a packed list, or None if there is no packed encoding for this type.

fn wrap_in_sequence() -> bool

Returns whether this field should be wrapped in a message when encoded nested in a sequence (such as a repeated field).

fn write_field_in_sequence(item: T, writer: &mut SequenceWriter<'_, '_, R>)

Writes this field as part of a sequence, wrapping it in a message if necessary.

fn compute_field_size_in_sequence(item: &mut T, sizer: &mut SequenceSizer<'_>)

Computes the size of this field as part of a sequence, including the size of a wrapping message.

const ENTRY: EncoderEntry<T, R> = _

The table encoder entry for this type, used in types from table::encode.

impl<C> PackedDecode<'_, u8, C> for ByteField

where C: CopyExtend<u8>,

fn read_packed( &self, data: &mut C, reader: &mut PackedReader<'_>, ) -> Result<(), Error>

Reads from the packed format into data.

fn must_pack(&self) -> bool

If true, when this type is decoded as part of a sequence, it must be done with read_packed and not the field methods.

impl PackedEncode<u8> for ByteField

fn write_packed(&self, data: &[u8], writer: PackedWriter<'_, '_>)

Writes a slice of data in packed format.

fn compute_packed_size(&self, data: &[u8], sizer: PackedSizer<'_>)

Computes the size of the data in packed format.

fn must_pack(&self) -> bool

If true, when this type is encoded as part of a sequence, it cannot be encoded with a normal repeated encoding and must be packed. This is used to determine if a nested repeated sequence needs to be wrapped in a message to avoid ambiguity.