Struct SharedPtr

#[repr(C)]
pub struct SharedPtr<T>
where
    T: SharedPtrTarget,
{ /* private fields */ }

Binding to C++ std::shared_ptr<T>.

Implementations

impl<T> SharedPtr<T>

where T: SharedPtrTarget,

pub fn null() -> Self

Makes a new SharedPtr wrapping a null pointer.

Matches the behavior of default-constructing a std::shared_ptr.

pub fn new(value: T) -> Self

where T: ExternType<Kind = Trivial>,

Allocates memory on the heap and makes a SharedPtr owner for it.

pub fn is_null(&self) -> bool

Checks whether the SharedPtr does not own an object.

This is the opposite of std::shared_ptr<T>::operator bool.

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

Returns a reference to the object owned by this SharedPtr if any, otherwise None.

pub fn downgrade(self: &SharedPtr<T>) -> WeakPtr<T>

where T: WeakPtrTarget,

Constructs new WeakPtr as a non-owning reference to the object managed by self. If self manages no object, the WeakPtr manages no object too.

Matches the behavior of std::weak_ptr<T>::weak_ptr(const std::shared_ptr<T> &).

Trait Implementations

impl<T> Clone for SharedPtr<T>

where T: SharedPtrTarget,

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 SharedPtr<T>

where T: Debug + SharedPtrTarget,

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

Formats the value using the given formatter.

impl<T> Deref for SharedPtr<T>

where T: SharedPtrTarget,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> Display for SharedPtr<T>

where T: Display + SharedPtrTarget,

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

Formats the value using the given formatter.

impl<T> Drop for SharedPtr<T>

where T: SharedPtrTarget,

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Send for SharedPtr<T>

where T: Send + Sync + SharedPtrTarget,

impl<T> Sync for SharedPtr<T>

where T: Send + Sync + SharedPtrTarget,

impl<T> Unpin for SharedPtr<T>

where T: SharedPtrTarget,