SharedManager

Struct SharedManager 

Source
pub struct SharedManager { /* private fields */ }
Expand description

A shared manager that coordinates memory reclamation across executors.

The SharedManager is the central structure that keeps a number of registered executors, a number of executors that passed the current epoch, and the current epoch number.

Executors register themselves with the SharedManager and get a thread-local LocalManager, which they use to schedule memory for deallocation or dropping.

The SharedManager ensures that memory is only freed when it is safe — that is, once all executors have advanced past the epoch in which the memory was retired.

§Usage

  1. Create a new SharedManager with SharedManager::new.
  2. For each executor (thread or runtime worker), call SharedManager::register_new_executor to install a thread-local LocalManager.
  3. Executors periodically call LocalManager::maybe_pass_epoch to advance epochs and allow reclamation.
  4. When an executor is done, it must deregister with unsafe { LocalManager::deregister() }.

§Example

You can find a very detailed example in the LocalManager’s docs.

Implementations§

Source§

impl SharedManager

Source

pub fn new() -> Self

Creates a new SharedManager.

This function initializes the global epoch and prepares the internal state for executor registration.

Source

pub fn register_new_executor(&self)

Registers a new executor in the current thread.

This creates and installs a thread-local LocalManager associated with this SharedManager.

§Panics

Panics if the current thread already has a registered LocalManager.

Trait Implementations§

Source§

impl Clone for SharedManager

Source§

fn clone(&self) -> SharedManager

Returns a duplicate 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 Default for SharedManager

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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