Struct mesh::payload::encoding::ZeroCopyEncoding
source · pub struct ZeroCopyEncoding;
Expand description
A field encoding for C-format structs.
Messages will be encoded as bytes
fields whose size must exactly match the
struct’s size.
Missing fields will be zero-initialized during message decode.
Trait Implementations§
source§impl<T> DescribeField<T> for ZeroCopyEncoding
impl<T> DescribeField<T> for ZeroCopyEncoding
source§const FIELD_TYPE: FieldType<'static> = _
const FIELD_TYPE: FieldType<'static> = _
The type of the field.
source§const PACKED_TYPE: Option<&'static str> = None
const PACKED_TYPE: Option<&'static str> = None
The type name of the field in a packed context.
source§impl<'a, T, R> FieldDecode<'a, T, R> for ZeroCopyEncodingwhere
T: FromBytes,
impl<'a, T, R> FieldDecode<'a, T, R> for ZeroCopyEncodingwhere
T: FromBytes,
source§fn read_field(
item: &mut InplaceOption<'_, T>,
reader: FieldReader<'a, '_, R>,
) -> Result<(), Error>
fn read_field( item: &mut InplaceOption<'_, T>, reader: FieldReader<'a, '_, R>, ) -> Result<(), Error>
Reads a field into
item
.source§fn default_field(item: &mut InplaceOption<'_, T>) -> Result<(), Error>
fn default_field(item: &mut InplaceOption<'_, T>) -> Result<(), Error>
Instantiates
item
with its default value, if there is one. Read moresource§fn packed<'p, C>() -> Option<&'p dyn PackedDecode<'a, T, C>>where
C: CopyExtend<T>,
T: 'p,
fn packed<'p, C>() -> Option<&'p dyn PackedDecode<'a, T, C>>where
C: CopyExtend<T>,
T: 'p,
Unless
packed()::must_pack()
is true, the sequence decoder must detect
the encoding (packed or not) and call the appropriate method.source§fn wrap_in_sequence() -> bool
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).
source§fn read_field_in_sequence(
item: &mut InplaceOption<'_, T>,
reader: FieldReader<'a, '_, R>,
) -> Result<(), Error>
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.
source§const ENTRY: DecoderEntry<'a, T, R> = _
const ENTRY: DecoderEntry<'a, T, R> = _
The table decoder entry for this type, used in types from
table::decode
. Read moresource§impl<T, R> FieldEncode<T, R> for ZeroCopyEncodingwhere
T: AsBytes,
impl<T, R> FieldEncode<T, R> for ZeroCopyEncodingwhere
T: AsBytes,
source§fn write_field(item: T, writer: FieldWriter<'_, '_, R>)
fn write_field(item: T, writer: FieldWriter<'_, '_, R>)
Writes
item
as a field.source§fn compute_field_size(item: &mut T, sizer: FieldSizer<'_>)
fn compute_field_size(item: &mut T, sizer: FieldSizer<'_>)
Computes the size of
item
as a field. Read moresource§fn packed<'a>() -> Option<&'a dyn PackedEncode<T>>where
T: 'a,
fn packed<'a>() -> Option<&'a dyn PackedEncode<T>>where
T: 'a,
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.source§fn wrap_in_sequence() -> bool
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). Read more
source§fn write_field_in_sequence(item: T, writer: &mut SequenceWriter<'_, '_, R>)
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.
source§fn compute_field_size_in_sequence(item: &mut T, sizer: &mut SequenceSizer<'_>)
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.
source§const ENTRY: EncoderEntry<T, R> = _
const ENTRY: EncoderEntry<T, R> = _
The table encoder entry for this type, used in types from
table::encode
. Read moreAuto Trait Implementations§
impl Freeze for ZeroCopyEncoding
impl RefUnwindSafe for ZeroCopyEncoding
impl Send for ZeroCopyEncoding
impl Sync for ZeroCopyEncoding
impl Unpin for ZeroCopyEncoding
impl UnwindSafe for ZeroCopyEncoding
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more