Struct kay::External

pub struct External<T> { /* fields omitted */ }

A Marker for state of an actor instance that is not managed by the actor system. As such it will not be compacted, nor persisted. External implements clone, so it can be used in actor state, but you have to ensure at runtime that only one actor or message ever holds onto an external. Any attempt to access the external from two different places will throw (see steal).

Methods

impl<T> External<T>

pub fn new(content: T) -> Self

Create a new External holding the given content

pub fn from_box(content: Box<T>) -> Self

Create a new External directly from a Box holding the given content

pub fn steal(&self) -> Self

A more explicit way to clone an External, which effectively takes the held value out of the old external. Stealing or cloning twice from the same external will throw.

pub fn into_box(self) -> Box<T>

Take the content out of the external, as a Box. This, like stealing/cloning can only be done once.

Trait Implementations

impl<T> Clone for External<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> DerefMut for External<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T> Deref for External<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> Compact for External<T>

fn is_still_compact(&self) -> bool

Is the object's dynamic part stored compactly?

fn dynamic_size_bytes(&self) -> usize

Size of the dynamic part in bytes

unsafe fn compact(
    source: *mut Self,
    dest: *mut Self,
    _new_dynamic_part: *mut u8
)

Copy the static part of source to dest and compactly store the dynamic part of source as the new dynamic part of dest at new_dynamic_part. This semantically moves source into dest.

unsafe fn decompact(source: *const Self) -> Self

Creates a clone of self with the dynamic part guaranteed to be stored freely.

fn total_size_bytes(&self) -> usize

Total size of the object (static part + dynamic part)

unsafe fn behind(ptr: *mut Self) -> *mut u8

Get a pointer to behind the static part of self (commonly used place for the dynamic part)

unsafe fn compact_behind(source: *mut Self, dest: *mut Self)

Like compact with new_dynamic_part set to dest.behind()