pub struct TyAndLayout<'a, Ty> {
    pub ty: Ty,
    pub layout: Layout<'a>,
}
Expand description

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

Note that the layout is NOT guaranteed to always be identical to that 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§layout: Layout<'a>

Implementations§

source§

impl<'a, Ty> TyAndLayout<'a, Ty>

source

fn is_aggregate(&self) -> bool

source

pub fn homogeneous_aggregate<C>( &self, cx: &C ) -> Result<HomogeneousAggregate, Heterogeneous>where Ty: TyAbiInterface<'a, C> + Copy,

Returns Homogeneous 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 1-ZST fields 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.

source§

impl<'a, Ty> TyAndLayout<'a, Ty>

source

pub fn for_variant<C>(self, cx: &C, variant_index: VariantIdx) -> Selfwhere Ty: TyAbiInterface<'a, C>,

source

pub fn field<C>(self, cx: &C, i: usize) -> Selfwhere Ty: TyAbiInterface<'a, C>,

source

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

source

pub fn is_single_fp_element<C>(self, cx: &C) -> boolwhere Ty: TyAbiInterface<'a, C>, C: HasDataLayout,

source

pub fn is_adt<C>(self) -> boolwhere Ty: TyAbiInterface<'a, C>,

source

pub fn is_never<C>(self) -> boolwhere Ty: TyAbiInterface<'a, C>,

source

pub fn is_tuple<C>(self) -> boolwhere Ty: TyAbiInterface<'a, C>,

source

pub fn is_unit<C>(self) -> boolwhere Ty: TyAbiInterface<'a, C>,

source

pub fn is_transparent<C>(self) -> boolwhere Ty: TyAbiInterface<'a, C>,

source

pub fn offset_of_subfield<C>( self, cx: &C, indices: impl Iterator<Item = usize> ) -> Sizewhere Ty: TyAbiInterface<'a, C>,

source

pub fn non_1zst_field<C>(&self, cx: &C) -> Option<(usize, Self)>where Ty: TyAbiInterface<'a, C> + Copy,

Finds the one field that is not a 1-ZST. Returns None if there are multiple non-1-ZST fields or only 1-ZST-fields.

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'a, Ty: Display> Debug for TyAndLayout<'a, Ty>

source§

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

Formats the value using the given formatter. Read more
source§

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

§

type Target = &'a LayoutS<FieldIdx, VariantIdx>

The resulting type after dereferencing.
source§

fn deref(&self) -> &&'a LayoutS<FieldIdx, VariantIdx>

Dereferences the value.
source§

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

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'a, Ty, __CTX> HashStable<__CTX> for TyAndLayout<'a, Ty>where __CTX: HashStableContext, Ty: HashStable<__CTX>,

source§

fn hash_stable(&self, __hcx: &mut __CTX, __hasher: &mut StableHasher)

source§

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

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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

source§

impl<'a, Ty> StructuralEq for TyAndLayout<'a, Ty>

source§

impl<'a, Ty> StructuralPartialEq for TyAndLayout<'a, Ty>

Auto Trait Implementations§

§

impl<'a, Ty> RefUnwindSafe for TyAndLayout<'a, Ty>where Ty: RefUnwindSafe,

§

impl<'a, Ty> Send for TyAndLayout<'a, Ty>where Ty: Send,

§

impl<'a, Ty> Sync for TyAndLayout<'a, Ty>where Ty: Sync,

§

impl<'a, Ty> Unpin for TyAndLayout<'a, Ty>where Ty: Unpin,

§

impl<'a, Ty> UnwindSafe for TyAndLayout<'a, Ty>where Ty: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.