Struct StableLike

#[repr(C)]
pub struct StableLike<T, As> { /* private fields */ }

Lets you tell stabby that T has the same stable layout as As.

Lying about this link between T and As will cause UB if a #[repr(stabby)] enum transitively contains a value of this type.

If you want to be safe when using this, use NoNiches with the correct size and alignment for your type.

Implementations

impl<T, As: IStable> StableLike<T, As>

pub const fn new(value: T) -> Self

Wraps a value in a type that provides information about its layout.

Asserts that T and As have the same size and aligment at compile time, and relies on the user for the niche information to be correct.

pub const unsafe fn as_ref_unchecked(&self) -> &T

Returns a reference to the underlying type

Safety

This is only safe if T is FFI-safe, or if this self was constructed from a value of T that was instanciated within the same shared object.

pub const fn as_ref(&self) -> &T

where T: IStable,

Returns a reference to the underlying type

pub const unsafe fn as_mut_unchecked(&mut self) -> &mut T

Safety

This is only safe if T is FFI-safe, or if this self was constructed from a value of T that was instanciated within the same shared object.

pub unsafe fn into_inner_unchecked(self) -> T

Safety

This is only safe if T is FFI-safe, or if this self was constructed from a value of T that was instanciated within the same shared object.

pub fn into_inner(self) -> T

where T: IStable,

Extracts the inner value from self

Trait Implementations

impl<T: Clone, As> Clone for StableLike<T, As>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, As> Debug for StableLike<T, As>

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

Formats the value using the given formatter.

impl<T: Display, As> Display for StableLike<T, As>

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

Formats the value using the given formatter.

impl<T: Hash, As: Hash> Hash for StableLike<T, As>

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<T, As: IStable> IStable for StableLike<T, As>

const ID: u64

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

const REPORT: &'static TypeReport = As::REPORT

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

type Size = <As as IStable>::Size

The size of the annotated type in bytes.

type Align = <As as IStable>::Align

The alignment of the annotated type in bytes.

type ForbiddenValues = <As as IStable>::ForbiddenValues

The values that the annotated type cannot occupy.

type UnusedBits = <As as IStable>::UnusedBits

The padding bits in the annotated types

type HasExactlyOneNiche = <As as IStable>::HasExactlyOneNiche

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

type ContainsIndirections = <As 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<T: Ord, As: Ord> Ord for StableLike<T, As>

fn cmp(&self, other: &StableLike<T, As>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq, As: PartialEq> PartialEq for StableLike<T, As>

fn eq(&self, other: &StableLike<T, As>) -> 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<T: PartialOrd, As: PartialOrd> PartialOrd for StableLike<T, As>

fn partial_cmp(&self, other: &StableLike<T, As>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Copy, As> Copy for StableLike<T, As>

impl<T: Eq, As: Eq> Eq for StableLike<T, As>

impl<T, As> StructuralPartialEq for StableLike<T, As>