Struct rustc_target::abi::TyLayout

pub struct TyLayout<'a, Ty> {
    pub ty: Ty,
    pub details: &'a LayoutDetails,
}

The details of the layout of a type, alongside the type itself. Provides various type traversal APIs (e.g., recursing into fields).

Note that the details are NOT guaranteed to always be identical to those obtained from layout_of(ty), as we need to produce layouts for which Rust types do not exist, such as enum variants or synthetic fields of enums (i.e., discriminants) and fat pointers.

Fields

ty: Ty

details: &'a LayoutDetails

Methods

impl<'a, Ty> TyLayout<'a, Ty>

pub fn homogeneous_aggregate<C>(&self, cx: &C) -> HomogeneousAggregate where
    Ty: TyLayoutMethods<'a, C> + Copy,
    C: LayoutOf<Ty = Ty, TyLayout = Self>, 

Returns true if this layout is an aggregate containing fields of only a single type (e.g., (u32, u32)). Such aggregates are often special-cased in ABIs.

Note: We generally ignore fields of zero-sized type when computing this value (see #56877).

This is public so that it can be used in unit tests, but should generally only be relevant to the ABI details of specific targets.

impl<'a, Ty> TyLayout<'a, Ty>

pub fn for_variant<C>(self, cx: &C, variant_index: VariantIdx) -> Self where
    Ty: TyLayoutMethods<'a, C>,
    C: LayoutOf<Ty = Ty>, 

pub fn field<C>(self, cx: &C, i: usize) -> C::TyLayout where
    Ty: TyLayoutMethods<'a, C>,
    C: LayoutOf<Ty = Ty>, 

pub fn pointee_info_at<C>(self, cx: &C, offset: Size) -> Option<PointeeInfo> where
    Ty: TyLayoutMethods<'a, C>,
    C: LayoutOf<Ty = Ty>, 

impl<'a, Ty> TyLayout<'a, Ty>

pub fn is_unsized(&self) -> bool

Returns true if the layout corresponds to an unsized type.

pub fn is_zst(&self) -> bool

Returns true if the type is a ZST and not unsized.

Methods from Deref<Target = &'a LayoutDetails>

Trait Implementations

impl<'a, Ty: Clone> Clone for TyLayout<'a, Ty>

fn clone(&self) -> TyLayout<'a, Ty>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, Ty: Eq> Eq for TyLayout<'a, Ty>

impl<'a, Ty: Copy> Copy for TyLayout<'a, Ty>

impl<'a, Ty: PartialEq> PartialEq<TyLayout<'a, Ty>> for TyLayout<'a, Ty>

fn eq(&self, other: &TyLayout<'a, Ty>) -> bool

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

fn ne(&self, other: &TyLayout<'a, Ty>) -> bool

This method tests for !=.

impl<'a, Ty> Deref for TyLayout<'a, Ty>

type Target = &'a LayoutDetails

The resulting type after dereferencing.

fn deref(&self) -> &&'a LayoutDetails

Dereferences the value.

impl<'a, Ty: Debug> Debug for TyLayout<'a, Ty>

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

Formats the value using the given formatter.

impl<'a, Ty: Hash> Hash for TyLayout<'a, Ty>

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].