Struct Shared 

pub struct Shared<'g, T> { /* private fields */ }

A pointer to a heap-allocated value protected by a guard.

This type represents a pointer that is guaranteed to remain valid for the lifetime of the guard. It cannot outlive the guard.

Safety

The pointer is only valid while the guard is alive. Dereferencing the pointer after the guard is dropped is undefined behavior.

Implementations

impl<'g, T> Shared<'g, T>

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

Creates a shared pointer from a raw pointer.

Safety

The caller must ensure the pointer is valid and will remain valid for the lifetime of the guard.

pub fn as_raw(&self) -> *mut T

Returns the raw pointer.

pub fn is_null(&self) -> bool

Returns true if the pointer is null.

pub unsafe fn as_ref(&self) -> Option<&'g T>

Converts to an optional reference.

Safety

The caller must ensure the pointer is properly aligned and points to a valid value of type T.

pub unsafe fn deref(&self) -> &'g T

Converts to a reference without checking for null.

Safety

The pointer must not be null and must point to a valid value.

pub unsafe fn as_mut(&mut self) -> Option<&'g mut T>

Converts to a mutable reference.

Safety

The caller must ensure exclusive access to the value.

Trait Implementations

impl<'g, T> Clone for Shared<'g, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'g, T> Debug for Shared<'g, T>

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

Formats the value using the given formatter.

impl<'g, T> PartialEq for Shared<'g, T>

fn eq(&self, other: &Self) -> 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<'g, T> Copy for Shared<'g, T>

impl<'g, T> Eq for Shared<'g, T>