Enum FieldsShape

pub enum FieldsShape<FieldIdx: Idx> {
    Primitive,
    Union(NonZeroUsize),
    Array {
        stride: Size,
        count: u64,
    },
    Arbitrary {
        offsets: IndexVec<FieldIdx, Size>,
        memory_index: IndexVec<FieldIdx, u32>,
    },
}

Describes how the fields of a type are located in memory.

Variants

Primitive

Scalar primitives and !, which never have fields.

Union(NonZeroUsize)

All fields start at no offset. The usize is the field count.

Array

Array/vector-like placement, with all fields of identical types.

Fields

stride: Size

count: u64

Arbitrary

Struct-like placement, with precomputed offsets.

Fields are guaranteed to not overlap, but note that gaps before, between and after all the fields are NOT always padding, and as such their contents may not be discarded. For example, enum variants leave a gap at the start, where the discriminant field in the enum layout goes.

Fields

offsets: IndexVec<FieldIdx, Size>

Offsets for the first byte of each field, ordered to match the source definition order. This vector does not go in increasing order.

memory_index: IndexVec<FieldIdx, u32>

Maps source order field indices to memory order indices, depending on how the fields were reordered (if at all). This is a permutation, with both the source order and the memory order using the same (0..n) index ranges.

Note that during computation of memory_index, sometimes it is easier to operate on the inverse mapping (that is, from memory order to source order), and that is usually named inverse_memory_index.

Implementations

impl<FieldIdx: Idx> FieldsShape<FieldIdx>

pub fn count(&self) -> usize

pub fn offset(&self, i: usize) -> Size

pub fn memory_index(&self, i: usize) -> usize

pub fn index_by_increasing_offset( &self, ) -> impl ExactSizeIterator<Item = usize> + '_

Gets source indices of the fields by increasing offsets.

Trait Implementations

impl<FieldIdx: Clone + Idx> Clone for FieldsShape<FieldIdx>

fn clone(&self) -> FieldsShape<FieldIdx>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<FieldIdx: Debug + Idx> Debug for FieldsShape<FieldIdx>

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

Formats the value using the given formatter.

impl<FieldIdx: Hash + Idx> Hash for FieldsShape<FieldIdx>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<FieldIdx: PartialEq + Idx> PartialEq for FieldsShape<FieldIdx>

fn eq(&self, other: &FieldsShape<FieldIdx>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<FieldIdx: Eq + Idx> Eq for FieldsShape<FieldIdx>

impl<FieldIdx: Idx> StructuralPartialEq for FieldsShape<FieldIdx>