Struct GlobalPtr

pub struct GlobalPtr<T> { /* private fields */ }

A global pointer, containing a fully qualified object ID and offset.

Implementations

impl<T> GlobalPtr<T>

pub fn new(id: ObjID, offset: u64) -> Self

Creates a new global pointer.

pub fn cast<U>(self) -> GlobalPtr<U>

Casts the global pointer to a different type.

pub fn is_local(&self, place: impl AsRef<ObjectHandle>) -> bool

Checks if the global pointer is local from the perspective of a given object.

pub unsafe fn resolve_stable(&self) -> Ref<'_, T>

Resolve a global pointer into a reference.

Safety

The underlying object must not mutate while the reference exists, unless the underlying type is Sync + Send. The memory referenced by the pointer must have an valid representation of the type.

pub unsafe fn resolve(&self) -> Ref<'_, T>

Resolve a global pointer into a reference.

Safety

The underlying object must not mutate while the reference exists, unless the underlying type is Sync + Send. The memory referenced by the pointer must have an valid representation of the type.

pub unsafe fn resolve_mut(&self) -> RefMut<'_, T>

Resolve a global pointer into a reference.

Safety

The underlying object must not mutate while the reference exists, unless the underlying type is Sync + Send. The memory referenced by the pointer must have an valid representation of the type. No other references may be alive referring to the underlying data.

pub fn is_null(&self) -> bool

Returns true if the global pointer is null.

pub fn id(&self) -> ObjID

Returns the object ID of the global pointer.

pub fn offset(&self) -> u64

Returns the offset of the global pointer.

Trait Implementations

impl<T> Clone for GlobalPtr<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> Debug for GlobalPtr<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for GlobalPtr<T>

fn default() -> GlobalPtr<T>

Returns the “default value” for a type.

impl<T> From<GlobalPtr<T>> for FotEntry

fn from(value: GlobalPtr<T>) -> Self

Converts to this type from the input type.

impl<'a, T> From<Ref<'a, T>> for GlobalPtr<T>

fn from(value: Ref<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T> From<RefMut<'a, T>> for GlobalPtr<T>

fn from(value: RefMut<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T> From<RefSlice<'a, T>> for GlobalPtr<T>

fn from(value: RefSlice<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T> From<RefSliceMut<'a, T>> for GlobalPtr<T>

fn from(value: RefSliceMut<'a, T>) -> Self

Converts to this type from the input type.

impl<T> From<TxRef<T>> for GlobalPtr<T>

fn from(value: TxRef<T>) -> Self

Converts to this type from the input type.

impl<T> From<TxRefSlice<T>> for GlobalPtr<T>

fn from(value: TxRefSlice<T>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for GlobalPtr<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for GlobalPtr<T>

fn cmp(&self, other: &GlobalPtr<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for GlobalPtr<T>

fn eq(&self, other: &GlobalPtr<T>) -> 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<T: PartialOrd> PartialOrd for GlobalPtr<T>

fn partial_cmp(&self, other: &GlobalPtr<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Copy for GlobalPtr<T>

impl<T: Eq> Eq for GlobalPtr<T>

impl<T: Invariant> Invariant for GlobalPtr<T>

impl<T> StructuralPartialEq for GlobalPtr<T>