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

Makes a new SharedPtr wrapping a null pointer.

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

pub fn new(value: T) -> SharedPtr<T>

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

Returns a duplicate 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<(), Error>

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) -> &<SharedPtr<T> as Deref>::Target

Dereferences the value.

impl<T> Display for SharedPtr<T>

where T: Display + SharedPtrTarget,

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

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

where T: Hash + SharedPtrTarget,

fn hash<H>(&self, hasher: &mut H)

where H: Hasher,

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

where T: Ord + SharedPtrTarget,

fn cmp(&self, other: &SharedPtr<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 for SharedPtr<T>

where T: PartialEq + SharedPtrTarget,

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

where T: PartialOrd + SharedPtrTarget,

fn partial_cmp(&self, other: &SharedPtr<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> Eq for SharedPtr<T>

where T: Eq + SharedPtrTarget,

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,