Struct abi_stable::type_layout::TypeLayout

source ·

#[repr(C)]
pub struct TypeLayout { /* private fields */ }

Expand description

The layout of a type, also includes metadata about where the type was defined.

Implementations

source

impl TypeLayout

source

pub const fn shared_vars(&self) -> &'static SharedVars

Gets the SharedVars of the type, containing the slices that many types inside TypeLayout contain ranges into.

source

pub fn package_and_version(&self) -> (RStr<'static>, VersionStrings)

Gets the package and package version where the type was declared.

source

pub fn package(&self) -> RStr<'static>

Gets the package where the type was declared.

source

pub fn package_version(&self) -> VersionStrings

Gets the package version for the package where the type was declared.

source

pub fn line(&self) -> u32

Gets which line the type was defined in.

source

pub fn mod_path(&self) -> ModPath

Gets the full path to the module where the type was defined.

source

pub fn extra_checks(&self) -> Option<ExtraChecksStaticRef>

Gets a trait object used to check extra properties about the type.

source

pub fn get_fields(&self) -> Option<TLFields>

Gets the fields of the type.

Return value

If this a:

primitive or opaque type: It returns None.
enum: It returns Some() with all the fields in the order that they were declared, ignoring variants.
structs/unions/prefix types: It returns Some() with all the fields in the order that they were declared.

source

pub fn is_prefix_kind(&self) -> bool

Whether this is a prefix-type(module or vtable).

source

pub fn name(&self) -> &'static str

Gets the name of the type.

source

pub fn is_nonzero(&self) -> bool

Gets whether the type is a NonZero type, which can be put in an Option while being ffi-safe.

source

pub fn get_utypeid(&self) -> UTypeId

Gets the UTypeId for the type, which is an ffi safe equivalent of TypeId.

source

pub fn item_info(&self) -> &ItemInfo

Gets information about where a type was declared.

source

pub fn alignment(&self) -> usize

Gets the alignment of the type.

source

pub fn size(&self) -> usize

Gets the size of the type.

source

pub fn tag(&self) -> &'static Tag

Gets the Tag associated with a type, a JSON-like datastructure which is another way to check extra properties about a type.

source

pub fn repr_attr(&self) -> ReprAttr

Gets the representation attribute of the type.

source

pub const fn mod_refl_mode(&self) -> ModReflMode

Gets the ModReflMode for the type, whether this is a module whose definition can be reflected on at runtime.

source

pub fn data(&self) -> TLData

The interior of the type definition, describing whether the type is a primitive/enum/struct/union and its contents.

source

pub fn data_discriminant(&self) -> TLDataDiscriminant

Describes whether the type is a primitive/enum/struct/union, every variant corresponds to a TLData variant of the same name.

source

pub fn phantom_fields(&self) -> TLFields

Gets the virtual fields that aren’t part of th type definition, but are checked as part of the type

source

pub fn generics(&self) -> GenericParams

Gets the generic parameters of the type.

source

pub fn mono_type_layout(&self) -> &MonoTypeLayout

Gets the parts of the type layout that don’t change with generic parameters.

Trait Implementations

source

impl Clone for TypeLayout

source

fn clone(&self) -> TypeLayout

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 Debug for TypeLayout

source

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

Formats the value using the given formatter. Read more

source

impl Display for TypeLayout

source

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

Formats the value using the given formatter. Read more

source

impl GetStaticEquivalent_ for TypeLayout

type StaticEquivalent = _static_TypeLayout

source

impl PartialEq<TypeLayout> for TypeLayout

source

fn eq(&self, other: &TypeLayout) -> bool

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

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. Read more

source

impl StableAbi for TypeLayout

type IsNonZeroType = False

Whether this type has a single invalid bit-pattern. Read more

source

const LAYOUT: &'static TypeLayout = _

The layout of the type provided by implementors.

source

const ABI_CONSTS: AbiConsts = _

const-equivalents of the associated types.

source

impl Sync for TypeLayout

Auto Trait Implementations

impl RefUnwindSafe for TypeLayout

impl Unpin for TypeLayout

impl UnwindSafe for TypeLayout

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<'a, T> BorrowOwned<'a> for Twhere
T: 'a + Clone,

type ROwned = T

The owned type, stored in RCow::Owned

type RBorrowed = &'a T

The borrowed type, stored in RCow::Borrowed

source

fn r_borrow(
this: &'a <T as BorrowOwned<'a>>::ROwned
) -> <T as BorrowOwned<'a>>::RBorrowed

source

fn r_to_owned(
this: <T as BorrowOwned<'a>>::RBorrowed
) -> <T as BorrowOwned<'a>>::ROwned

source

fn deref_borrowed(this: &<T as BorrowOwned<'a>>::RBorrowed) -> &T

source

fn deref_owned(this: &<T as BorrowOwned<'a>>::ROwned) -> &T

source

fn from_cow_borrow(this: &'a T) -> <T as BorrowOwned<'a>>::RBorrowed

source

fn from_cow_owned(this: <T as ToOwned>::Owned) -> <T as BorrowOwned<'a>>::ROwned

source

fn into_cow_borrow(this: <T as BorrowOwned<'a>>::RBorrowed) -> &'a T

source

fn into_cow_owned(this: <T as BorrowOwned<'a>>::ROwned) -> <T as ToOwned>::Owned

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> GetWithMetadata for T

type ForSelf = WithMetadata_<T, T>

This is always WithMetadata_<Self, Self>

source

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

const: unstable · 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<S> ROExtAcc for S

source

fn f_get<F>(&self, offset: FieldOffset<S, F, Aligned>) -> &F

Gets a reference to a field, determined by offset. Read more

source

fn f_get_mut<F>(&mut self, offset: FieldOffset<S, F, Aligned>) -> &mut F

Gets a muatble reference to a field, determined by offset. Read more

source

fn f_get_ptr<F, A>(&self, offset: FieldOffset<S, F, A>) -> *const F

Gets a const pointer to a field, the field is determined by offset. Read more

source

fn f_get_mut_ptr<F, A>(&mut self, offset: FieldOffset<S, F, A>) -> *mut F

Gets a mutable pointer to a field, determined by offset. Read more

source

impl<S> ROExtOps<Aligned> for S

source

fn f_replace<F>(&mut self, offset: FieldOffset<S, F, Aligned>, value: F) -> F

Replaces a field (determined by offset) with value, returning the previous value of the field. Read more

source

fn f_swap<F>(&mut self, offset: FieldOffset<S, F, Aligned>, right: &mut S)

Swaps a field (determined by offset) with the same field in right. Read more

source

fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Aligned>) -> Fwhere
F: Copy,

Gets a copy of a field (determined by offset). The field is determined by offset. Read more

source

impl<S> ROExtOps<Unaligned> for S

source

fn f_replace<F>(&mut self, offset: FieldOffset<S, F, Unaligned>, value: F) -> F

Replaces a field (determined by offset) with value, returning the previous value of the field. Read more

source

fn f_swap<F>(&mut self, offset: FieldOffset<S, F, Unaligned>, right: &mut S)

Swaps a field (determined by offset) with the same field in right. Read more

source

fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Unaligned>) -> Fwhere
F: Copy,

Gets a copy of a field (determined by offset). The field is determined by offset. Read more

source

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

source

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

Compares the address of self with the address of other. Read more

source

fn piped<F, U>(self, f: F) -> Uwhere
F: FnOnce(Self) -> U,
Self: Sized,

Emulates the pipeline operator, allowing method syntax in more places. Read more

source

fn piped_ref<'a, F, U>(&'a self, f: F) -> Uwhere
F: FnOnce(&'a Self) -> U,

The same as piped except that the function takes &Self Useful for functions that take &Self instead of Self. Read more

source

fn piped_mut<'a, F, U>(&'a mut self, f: F) -> Uwhere
F: FnOnce(&'a mut Self) -> U,

The same as piped, except that the function takes &mut Self. Useful for functions that take &mut Self instead of Self. Read more

source

fn mutated<F>(self, f: F) -> Selfwhere
F: FnOnce(&mut Self),
Self: Sized,

Mutates self using a closure taking self by mutable reference, passing it along the method chain. Read more

source

fn observe<F>(self, f: F) -> Selfwhere
F: FnOnce(&Self),
Self: Sized,

Observes the value of self, passing it along unmodified. Useful in long method chains. Read more

source

fn into_<T>(self) -> Twhere
Self: Into<T>,

Performs a conversion with Into. using the turbofish .into_::<_>() syntax. Read more

source

fn as_ref_<T>(&self) -> &Twhere
Self: AsRef<T>,
T: ?Sized,

Performs a reference to reference conversion with AsRef, using the turbofish .as_ref_::<_>() syntax. Read more

source

fn as_mut_<T>(&mut self) -> &mut Twhere
Self: AsMut<T>,
T: ?Sized,

Performs a mutable reference to mutable reference conversion with AsMut, using the turbofish .as_mut_::<_>() syntax. Read more

source

fn drop_(self)where
Self: Sized,

Drops self using method notation. Alternative to std::mem::drop. Read more

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> ToString for Twhere
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<This> TransmuteElement for Thiswhere
This: ?Sized,

source

unsafe fn transmute_element<T>(
self
) -> <Self as CanTransmuteElement<T>>::TransmutedPtrwhere
Self: CanTransmuteElement<T>,

Transmutes the element type of this pointer.. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Type = T

This is always Self.

source

fn into_type(self) -> Self::Typewhere
Self: Sized,
Self::Type: Sized,

Converts a value back to the original type.

source

fn as_type(&self) -> &Self::Type

Converts a reference back to the original type.

source

fn as_type_mut(&mut self) -> &mut Self::Type

Converts a mutable reference back to the original type.

source

fn into_type_box(self: Box<Self, Global>) -> Box<Self::Type, Global>

Converts a box back to the original type.

source

fn into_type_arc(this: Arc<Self>) -> Arc<Self::Type>

Converts an Arc back to the original type. Read more

source

fn into_type_rc(this: Rc<Self>) -> Rc<Self::Type>

Converts an Rc back to the original type. Read more

source

fn from_type(this: Self::Type) -> Selfwhere
Self: Sized,
Self::Type: Sized,

Converts a value back to the original type.

source

fn from_type_ref(this: &Self::Type) -> &Self

Converts a reference back to the original type.

source

fn from_type_mut(this: &mut Self::Type) -> &mut Self

Converts a mutable reference back to the original type.

source

fn from_type_box(this: Box<Self::Type, Global>) -> Box<Self, Global>

Converts a box back to the original type.

source

fn from_type_arc(this: Arc<Self::Type>) -> Arc<Self>

Converts an Arc back to the original type.

source

fn from_type_rc(this: Rc<Self::Type>) -> Rc<Self>

Converts an Rc back to the original type.

source

Struct abi_stable::type_layout::TypeLayout

Implementations

impl TypeLayout

pub const fn shared_vars(&self) -> &'static SharedVars

pub fn package_and_version(&self) -> (RStr<'static>, VersionStrings)

pub fn package(&self) -> RStr<'static>

pub fn package_version(&self) -> VersionStrings

pub fn line(&self) -> u32

pub fn mod_path(&self) -> ModPath

pub fn extra_checks(&self) -> Option<ExtraChecksStaticRef>

pub fn get_fields(&self) -> Option<TLFields>

Return value

pub fn is_prefix_kind(&self) -> bool

pub fn name(&self) -> &'static str

pub fn is_nonzero(&self) -> bool

pub fn get_utypeid(&self) -> UTypeId

pub fn item_info(&self) -> &ItemInfo

pub fn alignment(&self) -> usize

pub fn size(&self) -> usize

pub fn tag(&self) -> &'static Tag

pub fn repr_attr(&self) -> ReprAttr

pub const fn mod_refl_mode(&self) -> ModReflMode

pub fn data(&self) -> TLData

pub fn data_discriminant(&self) -> TLDataDiscriminant

pub fn phantom_fields(&self) -> TLFields

pub fn generics(&self) -> GenericParams

pub fn mono_type_layout(&self) -> &MonoTypeLayout

Trait Implementations

impl Clone for TypeLayout

fn clone(&self) -> TypeLayout

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

impl Debug for TypeLayout

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

impl Display for TypeLayout

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

impl GetStaticEquivalent_ for TypeLayout

type StaticEquivalent = _static_TypeLayout

impl PartialEq<TypeLayout> for TypeLayout

fn eq(&self, other: &TypeLayout) -> bool

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

impl StableAbi for TypeLayout

type IsNonZeroType = False

const LAYOUT: &'static TypeLayout = _

const ABI_CONSTS: AbiConsts = _

impl Copy for TypeLayout

impl Eq for TypeLayout

impl Send for TypeLayout

impl Sync for TypeLayout

Auto Trait Implementations

impl RefUnwindSafe for TypeLayout

impl Unpin for TypeLayout

impl UnwindSafe for TypeLayout

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<'a, T> BorrowOwned<'a> for Twhere T: 'a + Clone,

type ROwned = T

type RBorrowed = &'a T

fn r_borrow( this: &'a <T as BorrowOwned<'a>>::ROwned) -> <T as BorrowOwned<'a>>::RBorrowed

fn r_to_owned( this: <T as BorrowOwned<'a>>::RBorrowed) -> <T as BorrowOwned<'a>>::ROwned

fn deref_borrowed(this: &<T as BorrowOwned<'a>>::RBorrowed) -> &T

fn deref_owned(this: &<T as BorrowOwned<'a>>::ROwned) -> &T

fn from_cow_borrow(this: &'a T) -> <T as BorrowOwned<'a>>::RBorrowed

fn from_cow_owned(this: <T as ToOwned>::Owned) -> <T as BorrowOwned<'a>>::ROwned

fn into_cow_borrow(this: <T as BorrowOwned<'a>>::RBorrowed) -> &'a T

fn into_cow_owned(this: <T as BorrowOwned<'a>>::ROwned) -> <T as ToOwned>::Owned

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> GetWithMetadata for T

type ForSelf = WithMetadata_<T, T>

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

fn into(self) -> U

impl<S> ROExtAcc for S

fn f_get<F>(&self, offset: FieldOffset<S, F, Aligned>) -> &F

fn f_get_mut<F>(&mut self, offset: FieldOffset<S, F, Aligned>) -> &mut F

fn f_get_ptr<F, A>(&self, offset: FieldOffset<S, F, A>) -> *const F

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

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

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

impl<'a, T> BorrowOwned<'a> for Twhere
T: 'a + Clone,

fn r_borrow(
this: &'a <T as BorrowOwned<'a>>::ROwned
) -> <T as BorrowOwned<'a>>::RBorrowed

fn r_to_owned(
this: <T as BorrowOwned<'a>>::RBorrowed
) -> <T as BorrowOwned<'a>>::ROwned

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

fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Aligned>) -> Fwhere
F: Copy,

fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Unaligned>) -> Fwhere
F: Copy,

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

fn piped<F, U>(self, f: F) -> Uwhere
F: FnOnce(Self) -> U,
Self: Sized,

fn piped_ref<'a, F, U>(&'a self, f: F) -> Uwhere
F: FnOnce(&'a Self) -> U,

fn piped_mut<'a, F, U>(&'a mut self, f: F) -> Uwhere
F: FnOnce(&'a mut Self) -> U,

fn mutated<F>(self, f: F) -> Selfwhere
F: FnOnce(&mut Self),
Self: Sized,

fn observe<F>(self, f: F) -> Selfwhere
F: FnOnce(&Self),
Self: Sized,

fn into_<T>(self) -> Twhere
Self: Into<T>,

fn as_ref_<T>(&self) -> &Twhere
Self: AsRef<T>,
T: ?Sized,

fn as_mut_<T>(&mut self) -> &mut Twhere
Self: AsMut<T>,
T: ?Sized,

fn drop_(self)where
Self: Sized,

impl<T> ToOwned for Twhere
T: Clone,

impl<T> ToString for Twhere
T: Display + ?Sized,

impl<This> TransmuteElement for Thiswhere
This: ?Sized,

unsafe fn transmute_element<T>(
self
) -> <Self as CanTransmuteElement<T>>::TransmutedPtrwhere
Self: CanTransmuteElement<T>,

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

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

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

fn into_type(self) -> Self::Typewhere
Self: Sized,
Self::Type: Sized,

fn from_type(this: Self::Type) -> Selfwhere
Self: Sized,
Self::Type: Sized,

impl<This> ValidTag_Bounds for Thiswhere
This: Debug + Clone + PartialEq<This>,