Skip to main content

Orbitals

Struct Orbitals 

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

The fleet’s table of shared values. Cheap to clone.

Implementations§

Source§

impl Orbitals

Source

pub fn new(fleet: Arc<Fleet>) -> Result<Self>

Attach to the fleet’s table, creating it when this is the first process to ask. An in-memory fleet gets a table on the heap, shared by everything that holds the same fleet.

Source

pub fn allocate<T: Primitive>(&self, initial: T) -> Result<Orbital<T>>

Declare a value holding initial. The id inside the handle is what other processes open.

The slot is not given back until the table is reset, so the capacity counts declarations, not live values: declare a value once and keep it, as a static, rather than one per request.

Source

pub fn open<T: Primitive>(&self, id: OrbitalId) -> Result<Orbital<T>>

A handle to the value id names. An id of another type is Error::KindMismatch; an id this table did not mint, or minted before its last reset, is Error::Stale.

Source

pub fn reset_all(&self) -> Result<()>

Empty the table and start a new epoch, after which every earlier id is stale.

For the table’s owner, at a boot where no other process is attached and no handle is in use. A handle kept across a reset still points at its slot, which the next allocation may hand to someone else.

Remove the table’s SHM object. Existing mappings remain valid until their processes drop them.

Trait Implementations§

Source§

impl Clone for Orbitals

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

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.