Struct zerovec::ule::MultiFieldsULE

source · [−]

#[repr(transparent)]
pub struct MultiFieldsULE(_);

Expand description

This type is used by the custom derive to represent multiple VarULE fields packed into a single end-of-struct field. It is not recommended to use this type directly.

Logically, consider it to be (V1, V2, V3, ..) where V1 etc are potentially different VarULE types.

Internally, it is represented by a VarZeroSlice.

Implementations

source

impl MultiFieldsULE

source

pub fn compute_encoded_len_for(lengths: &[usize]) -> usize

Compute the amount of bytes needed to support elements with lengths lengths

source

pub fn new_from_lengths_partially_initialized<'a>(
lengths: &[usize],
output: &'a mut [u8]
) -> &'a mut Self

Construct a partially initialized MultiFieldsULE backed by a mutable byte buffer

source

pub unsafe fn set_field_at<T: VarULE + ?Sized, A: EncodeAsVarULE<T> + ?Sized>(
    &mut self,
    idx: usize,
    value: &A
)

Given a buffer of size obtained by Self::compute_encoded_len_for(), write element A to index idx

Safety

idx must be in range
T must be the appropriate type expected by the custom derive in this usage of this type

source

pub unsafe fn validate_field<T: VarULE + ?Sized>(
&self,
index: usize
) -> Result<(), ZeroVecError>

Validate field at index to see if it is a valid T VarULE type

Safety

index must be in range

source

pub unsafe fn get_field<T: VarULE + ?Sized>(&self, index: usize) -> &T

Get field at index as a value of type T

Safety

index must be in range
Element at index must have been created with the VarULE type T

source

pub unsafe fn from_byte_slice_unchecked(bytes: &[u8]) -> &Self

Construct from a byte slice

Safety

byte slice must be a valid VarZeroSlice<u8>

Trait Implementations

source

impl PartialEq<MultiFieldsULE> for MultiFieldsULE

source

fn eq(&self, other: &MultiFieldsULE) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &MultiFieldsULE) -> bool

This method tests for !=.

source

impl VarULE for MultiFieldsULE

source

fn validate_byte_slice(slice: &[u8]) -> Result<(), ZeroVecError>

Note: MultiFieldsULE is usually used in cases where one should be calling .validate_field() directly for each field, rather than using the regular VarULE impl.

This impl exists so that EncodeAsVarULE can work.

source

unsafe fn from_byte_slice_unchecked(bytes: &[u8]) -> &Self

Takes a byte slice, &[u8], and return it as &Self with the same lifetime, assuming that this byte slice has previously been run through Self::parse_byte_slice() with success. Read more

source