Skip to main content

CaptureKind

Enum CaptureKind 

Source
pub enum CaptureKind {
    Immutable,
    OwnedMutable,
    Shared,
}
Expand description

Storage discipline for a closure capture.

Each capture index i has exactly one CaptureKind. The three kinds are mutually exclusive and map to three mutually-exclusive bitmasks on ClosureLayout (heap_capture_mask, owned_mutable_capture_mask, shared_capture_mask).

  • Immutablelet by-move/copy captures. The slot’s width follows capture_types[i] via FieldKind; reads and writes go through super::closure_raw::read_capture_as_value_bits and super::closure_raw::write_capture_typed as today. If the underlying field kind is Ptr, the slot owns one heap-refcount share (participates in heap_capture_mask).
  • OwnedMutablelet mut by-move captures. The 8-byte slot holds *mut ValueWord obtained from Box::into_raw(Box::new(...)). Exactly one closure owns the box; Drop reclaims it with Box::from_raw. The interior ValueWord can itself carry heap refcount shares — those must be dropped before the box is freed.
  • Sharedvar captures shared across nested closures. The 8-byte slot holds *const SharedCell obtained from Arc::into_raw(Arc::new(Mutex::new(...))). Each slot counts as one Arc strong share; reads/writes take the parking_lot mutex.

Variants§

§

Immutable

let binding: value in slot, width per FieldKind.

§

OwnedMutable

let mut binding: Ptr slot holds *mut ValueWord (Box cell).

§

Shared

var binding: Ptr slot holds *const SharedCell (Arc<parking_lot::Mutex<ValueWord>> via Arc::into_raw).

Trait Implementations§

Source§

impl Clone for CaptureKind

Source§

fn clone(&self) -> CaptureKind

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

Source§

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

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

impl Hash for CaptureKind

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 CaptureKind

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for CaptureKind

Source§

impl Eq for CaptureKind

Source§

impl StructuralPartialEq for CaptureKind

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

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.
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,