Skip to main content

OwnershipKind

Enum OwnershipKind 

Source
#[repr(u8)]
pub enum OwnershipKind { Owned = 0, Strong = 1, Weak = 2, Ref = 3, }
Expand description

The four ownership kinds an interpreted reference can carry — re-exported from the primitives, the crate-wide vocabulary. A Foreign leaf, a struct field, and a variant payload all classify with it. The ownership relationship a reference has with its target — the crate’s four in-file reference kinds, the axis that selects teardown / deep-clone / refcount behaviour for a field, a variant payload, or a cross-file Foreign pointer.

This is the single vocabulary the whole crate branches on; the derive’s field classifier, the RTTI interpreter, and the Foreign teardown helpers all express the same four cases.

Variants§

§

Owned = 0

Owned (#[bstack_owned]): sole ownership. Torn down (freed) and deep-cloned with its target.

§

Strong = 1

Strong (#[bstack_strong]): a shared, refcounted reference. Teardown decrements the strong count (freeing at zero); clone increments it.

§

Weak = 2

Weak (#[bstack_weak]): a non-owning refcounted reference to a control block. Teardown decrements the weak count; never keeps the target alive.

§

Ref = 3

Ref (#[bstack_ref]): a plain borrow — a bare offset with no ownership. Teardown and clone leave the target untouched.

Implementations§

Source§

impl OwnershipKind

Source

pub const ALL: [OwnershipKind; 4]

All four kinds, in declaration order.

Source

pub const fn as_u8(self) -> u8

The kind’s stable 1-byte discriminant (Owned=0, Strong=1, Weak=2, Ref=3) — the on-disk / wire encoding.

Source

pub const fn from_u8(v: u8) -> Option<Self>

Decode a kind from its as_u8 discriminant, or None for an out-of-range byte (corrupt / forged data).

Source

pub const fn is_owning(self) -> bool

Whether this kind keeps its target alive (frees or refcounts it): Owned or Strong, as opposed to the non-owning Weak / Ref.

Trait Implementations§

Source§

impl Clone for OwnershipKind

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for OwnershipKind

Source§

impl Debug for OwnershipKind

Source§

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

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

impl Eq for OwnershipKind

Source§

impl From<OwnershipKind> for u8

Source§

fn from(k: OwnershipKind) -> u8

Converts to this type from the input type.
Source§

impl Hash for OwnershipKind

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 PartialEq for OwnershipKind

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OwnershipKind

Source§

impl TryFrom<u8> for OwnershipKind

Source§

type Error = InvalidOwnershipKind

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

fn try_from(v: u8) -> Result<Self, InvalidOwnershipKind>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.