Struct SeqLock 

pub struct SeqLock<H: IntoBytes + Immutable, T: IntoBytes + Immutable> { /* private fields */ }

Declare an instance of SeqLock by supplying header([H]) and value([T]) types, which should be configured with C-style layout & alignment. SeqLock will place a 32-bit atomic sequence number in-between the header and value, in a VMO.

Implementations

impl<H: IntoBytes + Default + Immutable, T: IntoBytes + Default + Immutable> SeqLock<H, T>

pub fn new_default() -> Result<Self, Status>

impl<H: IntoBytes + Immutable, T: IntoBytes + Immutable> SeqLock<H, T>

pub fn new(header: H, value: T) -> Result<Self, Status>

Returns an instance with initial values and a read-only VMO handle. May fail if the VMO backing the structure cannot be created, duplicated read-only, or mapped.

pub unsafe fn new_from_vmo( header: H, value: T, writable_vmo: Vmo, ) -> Result<Self, Status>

Same as new() except that we can pass in an existing Vmo. This means that the first part of the Vmo is a SeqLock.

Safety

Callers must guarantee that any other references to this memory will only make aligned atomic accesses to the sequence offset within the memory or to fields of H or T.

pub fn get_readonly_vmo(&self) -> Arc<Vmo>

Returns a read-only handle to the VMO containing the header, atomic sequence number, and value.

pub fn set_value(&self, value: T)

Updates the value directly. Uses Seqlock pattern.

pub fn get_map_address(&mut self) -> *const T

Retrieves the memory address of the beginning of the handle part of the VMO. You can use this to point to a param you want to edit (e.g. with an offset).

Trait Implementations

impl<H: IntoBytes + Immutable, T: IntoBytes + Immutable> Drop for SeqLock<H, T>

fn drop(&mut self)

Executes the destructor for this type.