Struct PointerOffset 

pub struct PointerOffset(/* private fields */);

An offset to a SharedMemory address. It requires the

SharedMemory::payload_start_address() of the corresponding SharedMemory to be converted into an actual pointer.

Contains the offset and the corresponding SegmentId.

Implementations

impl PointerOffset

pub const fn new(offset: usize) -> PointerOffset

Creates a new PointerOffset from the given offset value with the SegmentId == 0.

pub const fn from_offset_and_segment_id( offset: usize, segment_id: SegmentId, ) -> PointerOffset

Creates a new PointerOffset from an offset and a SegmentId

pub const fn from_value(value: u64) -> PointerOffset

Creates a new PointerOffset from a provided raw value.

pub const fn as_value(&self) -> u64

Returns the underlying raw value of the PointerOffset

pub fn set_segment_id(&mut self, value: SegmentId)

Sets the SegmentId of the PointerOffset.

pub const fn offset(&self) -> usize

Returns the offset.

pub const fn segment_id(&self) -> SegmentId

Returns the SegmentId.

Trait Implementations

impl Clone for PointerOffset

fn clone(&self) -> PointerOffset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PointerOffset

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

Formats the value using the given formatter.

impl PartialEq for PointerOffset

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for PointerOffset

impl Eq for PointerOffset

impl StructuralPartialEq for PointerOffset