Struct cxx::SharedPtr

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

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

Implementations§

source§

impl<T> SharedPtr<T>
where T: SharedPtrTarget,

source

pub fn null() -> Self

Makes a new SharedPtr wrapping a null pointer.

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

source

pub fn new(value: T) -> Self
where T: ExternType<Kind = Trivial>,

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

source

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.

source

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

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

source

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§

source§

impl<T> Clone for SharedPtr<T>
where T: SharedPtrTarget,

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T> Debug for SharedPtr<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Deref for SharedPtr<T>
where T: SharedPtrTarget,

§

type Target = T

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl<T> Display for SharedPtr<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Drop for SharedPtr<T>
where T: SharedPtrTarget,

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<T> Send for SharedPtr<T>
where T: Send + Sync + SharedPtrTarget,

source§

impl<T> Sync for SharedPtr<T>
where T: Send + Sync + SharedPtrTarget,

source§

impl<T> Unpin for SharedPtr<T>
where T: SharedPtrTarget,

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for SharedPtr<T>
where T: RefUnwindSafe,

§

impl<T> UnwindSafe for SharedPtr<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.