Struct shadow_rs::utility::HostTreePointer

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

A pointer to an object that is safe to dereference from any thread, if the Host lock for the specified host is held.

Implementations

impl<T> HostTreePointer<T>

pub fn new_for_host(host_id: HostId, ptr: *mut T) -> Self

Create a pointer that may only be accessed when the host with id host_id is active.

pub fn new(ptr: *mut T) -> Self

Create a pointer that may only be accessed when the current host is active.

pub unsafe fn ptr(&self) -> *mut T

Get the pointer.

Panics if the configured host is not active.

Safety

Pointer must only be dereferenced while the configures Host is still active, in addition to the normal safety requirements for dereferencing a pointer.

pub unsafe fn ptr_with_host(&self, host: &Host) -> *mut T

Get the pointer.

Panics if host is not the one associated with self.

Safety

Pointer must only be dereferenced while the configures Host is still active, in addition to the normal safety requirements for dereferencing a pointer.

pub unsafe fn ptr_unchecked(&self) -> *mut T

Get the pointer without checking the active host.

Safety

Pointer must only be dereferenced while the configures Host is still active, in addition to the normal safety requirements for dereferencing a pointer.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T> Copy for HostTreePointer<T>

impl<T> Send for HostTreePointer<T>

impl<T> Sync for HostTreePointer<T>