# Struct rustc_target::abi::LayoutS

source ·

    pub struct LayoutS<FieldIdx, VariantIdx>where
        FieldIdx: Idx,
        VariantIdx: Idx,{
        pub fields: FieldsShape<FieldIdx>,
        pub variants: Variants<FieldIdx, VariantIdx>,
        pub abi: Abi,
        pub largest_niche: Option<Niche>,
        pub align: AbiAndPrefAlign,
        pub size: Size,
        pub max_repr_align: Option<Align>,
        pub unadjusted_abi_align: Align,
    }

## Fields§

§`fields: FieldsShape<FieldIdx>`

Says where the fields are located within the layout.

§`variants: Variants<FieldIdx, VariantIdx>`

Encodes information about multi-variant layouts. Even with `Multiple` variants, a layout still has its own fields! Those are then shared between all variants. One of them will be the discriminant, but e.g. coroutines can have more.

To access all fields of this layout, both `fields` and the fields of the active variant must be taken into account.

§`abi: Abi`

The `abi` defines how this data is passed between functions, and it defines value restrictions via `valid_range`.

Note that this is entirely orthogonal to the recursive structure defined by `variants` and `fields`; for example, `ManuallyDrop<Result<isize, isize>>` has `Abi::ScalarPair`! So, even with non-`Aggregate` `abi`, `fields` and `variants` have to be taken into account to find all fields of this layout.

§`largest_niche: Option<Niche>`

The leaf scalar with the largest number of invalid values (i.e. outside of its `valid_range`), if it exists.

§`align: AbiAndPrefAlign`§`size: Size`§`max_repr_align: Option<Align>`

The largest alignment explicitly requested with `repr(align)` on this type or any field. Only used on i686-windows, where the argument passing ABI is different when alignment is requested, even if the requested alignment is equal to the natural alignment.

§`unadjusted_abi_align: Align`

The alignment the type would have, ignoring any `repr(align)` but including `repr(packed)`. Only used on aarch64-linux, where the argument passing ABI ignores the requested alignment in some cases.

## Implementations§

source§

### impl<FieldIdx, VariantIdx> LayoutS<FieldIdx, VariantIdx>
where FieldIdx: Idx, VariantIdx: Idx,

source

#### pub fn scalar<C>(cx: &C, scalar: Scalar) -> LayoutS<FieldIdx, VariantIdx>
where C: HasDataLayout,

source§

### impl<FieldIdx, VariantIdx> LayoutS<FieldIdx, VariantIdx>
where FieldIdx: Idx, VariantIdx: Idx,

source

#### pub fn is_unsized(&self) -> bool

Returns `true` if the layout corresponds to an unsized type.

source

#### pub fn is_sized(&self) -> bool

source

#### pub fn is_1zst(&self) -> bool

Returns `true` if the type is sized and a 1-ZST (meaning it has size 0 and alignment 1).

source

#### pub fn is_zst(&self) -> bool

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

Note that this does not imply that the type is irrelevant for layout! It can still have non-trivial alignment constraints. You probably want to use `is_1zst` instead.

source

#### pub fn eq_abi(&self, other: &LayoutS<FieldIdx, VariantIdx>) -> bool

Checks if these two `Layout` are equal enough to be considered “the same for all function call ABIs”. Note however that real ABIs depend on more details that are not reflected in the `Layout`; the `PassMode` need to be compared as well.

## Trait Implementations§

source§

### impl<FieldIdx, VariantIdx> Clone for LayoutS<FieldIdx, VariantIdx>
where FieldIdx: Clone + Idx, VariantIdx: Clone + Idx,

source§

#### fn clone(&self) -> LayoutS<FieldIdx, VariantIdx>

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<FieldIdx, VariantIdx> Debug for LayoutS<FieldIdx, VariantIdx>
where FieldIdx: Idx, VariantIdx: Idx, FieldsShape<FieldIdx>: Debug, Variants<FieldIdx, VariantIdx>: Debug,

source§

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

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

### impl<FieldIdx, VariantIdx> Hash for LayoutS<FieldIdx, VariantIdx>
where FieldIdx: Hash + Idx, VariantIdx: Hash + Idx,

source§

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

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<FieldIdx, VariantIdx, __CTX> HashStable<__CTX> for LayoutS<FieldIdx, VariantIdx>
where FieldIdx: Idx + HashStable<__CTX>, VariantIdx: Idx + HashStable<__CTX>, __CTX: HashStableContext,

source§

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

source§

### impl<FieldIdx, VariantIdx> PartialEq for LayoutS<FieldIdx, VariantIdx>
where FieldIdx: PartialEq + Idx, VariantIdx: PartialEq + Idx,

source§

#### fn eq(&self, other: &LayoutS<FieldIdx, VariantIdx>) -> 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<FieldIdx, VariantIdx> Eq for LayoutS<FieldIdx, VariantIdx>
where FieldIdx: Eq + Idx, VariantIdx: Eq + Idx,

source§

### impl<FieldIdx, VariantIdx> StructuralPartialEq for LayoutS<FieldIdx, VariantIdx>
where FieldIdx: Idx, VariantIdx: Idx,

## Auto Trait Implementations§

§

### impl<FieldIdx, VariantIdx> DynSend for LayoutS<FieldIdx, VariantIdx>
where VariantIdx: DynSend,

§

### impl<FieldIdx, VariantIdx> DynSync for LayoutS<FieldIdx, VariantIdx>
where VariantIdx: DynSync,

§

### impl<FieldIdx, VariantIdx> Freeze for LayoutS<FieldIdx, VariantIdx>
where VariantIdx: Freeze,

§

### impl<FieldIdx, VariantIdx> RefUnwindSafe for LayoutS<FieldIdx, VariantIdx>
where VariantIdx: RefUnwindSafe,

§

### impl<FieldIdx, VariantIdx> Send for LayoutS<FieldIdx, VariantIdx>
where VariantIdx: Send,

§

### impl<FieldIdx, VariantIdx> Sync for LayoutS<FieldIdx, VariantIdx>
where VariantIdx: Sync,

§

### impl<FieldIdx, VariantIdx> Unpin for LayoutS<FieldIdx, VariantIdx>
where VariantIdx: Unpin,

§

### impl<FieldIdx, VariantIdx> UnwindSafe for LayoutS<FieldIdx, VariantIdx>
where VariantIdx: UnwindSafe,

## Blanket Implementations§

source§

### impl<T> Aligned for T

source§

#### const ALIGN: Alignment = _

Alignment of `Self`.
source§

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

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for T
where T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T> Instrument for T

source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
source§

### impl<T, U> Into<U> for T
where 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.

§

### impl<T> Pointable for T

§

#### const ALIGN: usize = _

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
source§

### impl<T> ToOwned for T
where 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 T
where 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 T
where 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.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

source§

### impl<T> WithSubscriber for T

source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
source§

### impl<'a, T> Captures<'a> for T
where T: ?Sized,

## 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.