Struct TypeReport

#[repr(C)]
pub struct TypeReport {
    pub name: Str<'static>,
    pub module: Str<'static>,
    pub fields: StableLike<Option<&'static FieldReport>, usize>,
    pub tyty: TyTy,
    pub version: u32,
}

A report of a type’s layout.

Fields

name: Str<'static>

The type’s name.

module: Str<'static>

The type’s parent module’s path.

fields: StableLike<Option<&'static FieldReport>, usize>

The fields of this type.

tyty: TyTy

How the type was declared

version: u32

The version of the type’s invariants.

Implementations

impl TypeReport

where Struct<FieldPair<FieldPair<FieldPair<FieldPair<Str<'static>, Str<'static>>, StableLike<Option<&'static FieldReport>, usize>>, TyTy>, u32>>: IStable, u32: IStable, TyTy: IStable, StableLike<Option<&'static FieldReport>, usize>: IStable, Str<'static>: IStable,

pub const fn has_optimal_layout() -> bool

Returns true if the layout for TypeReport is smaller or equal to that Rust would have generated for it.

impl TypeReport

pub fn is_compatible(&self, other: &Self) -> bool

Whether or not two reports correspond to the same type, with the same layout and invariants.

impl TypeReport

pub const fn fields(&self) -> Fields

Returns an iterator over the type’s fields.

Trait Implementations

impl Clone for TypeReport

fn clone(&self) -> TypeReport

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TypeReport

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

Formats the value using the given formatter.

impl Display for TypeReport

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

Formats the value using the given formatter.

impl Hash for TypeReport

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 IStable for TypeReport

where Struct<FieldPair<FieldPair<FieldPair<FieldPair<Str<'static>, Str<'static>>, StableLike<Option<&'static FieldReport>, usize>>, TyTy>, u32>>: IStable, u32: IStable, TyTy: IStable, StableLike<Option<&'static FieldReport>, usize>: IStable, Str<'static>: IStable,

const REPORT: &'static TypeReport

A compile-time generated report of the fields of the type, allowing for compatibility inspection.

const ID: u64

A stable (and ideally unique) identifier for the type. Often generated using crate::report::gen_id, but can be manually set.

type ForbiddenValues = <Struct<FieldPair<FieldPair<FieldPair<FieldPair<Str<'static>, Str<'static>>, StableLike<Option<&'static FieldReport>, usize>>, TyTy>, u32>> as IStable>::ForbiddenValues

The values that the annotated type cannot occupy.

type UnusedBits = <Struct<FieldPair<FieldPair<FieldPair<FieldPair<Str<'static>, Str<'static>>, StableLike<Option<&'static FieldReport>, usize>>, TyTy>, u32>> as IStable>::UnusedBits

The padding bits in the annotated types

type Size = <Struct<FieldPair<FieldPair<FieldPair<FieldPair<Str<'static>, Str<'static>>, StableLike<Option<&'static FieldReport>, usize>>, TyTy>, u32>> as IStable>::Size

The size of the annotated type in bytes.

type Align = <Struct<FieldPair<FieldPair<FieldPair<FieldPair<Str<'static>, Str<'static>>, StableLike<Option<&'static FieldReport>, usize>>, TyTy>, u32>> as IStable>::Align

The alignment of the annotated type in bytes.

type HasExactlyOneNiche = <Struct<FieldPair<FieldPair<FieldPair<FieldPair<Str<'static>, Str<'static>>, StableLike<Option<&'static FieldReport>, usize>>, TyTy>, u32>> as IStable>::HasExactlyOneNiche

Allows the detection of whether or not core::option::Options are stable:

type ContainsIndirections = <Struct<FieldPair<FieldPair<FieldPair<FieldPair<Str<'static>, Str<'static>>, StableLike<Option<&'static FieldReport>, usize>>, TyTy>, u32>> as IStable>::ContainsIndirections

Whether or not the type contains indirections (pointers, indices in independent data-structures…)

fn size() -> usize

Returns the size of the type.

fn align() -> usize

Returns the alignment of the type.

unsafe fn is_invalid(ptr: *const u8) -> bool

Returns true if ptr points to memory that cannot be a valid value of Self.

impl PartialEq for TypeReport

fn eq(&self, other: &TypeReport) -> 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 Copy for TypeReport

impl Eq for TypeReport

impl StructuralPartialEq for TypeReport