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> where
T: Debug + SharedPtrTarget,

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> where
T: Display + SharedPtrTarget,

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,

Auto Trait Implementations

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

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

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct cxx::SharedPtr

Implementations

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

pub fn null() -> Self

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

pub fn is_null(&self) -> bool

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

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

Trait Implementations

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

fn clone(&self) -> Self

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

impl<T> Debug for SharedPtr<T> where T: Debug + SharedPtrTarget,

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

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

type Target = T

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

impl<T> Display for SharedPtr<T> where T: Display + SharedPtrTarget,

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

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

fn drop(&mut self)

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

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

Auto Trait Implementations

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

default fn to_string(&self) -> String

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

type Error = Infallible

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

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

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

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

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

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

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

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

impl<T> Debug for SharedPtr<T> where
T: Debug + SharedPtrTarget,

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

impl<T> Display for SharedPtr<T> where
T: Display + SharedPtrTarget,

impl<T> Drop for SharedPtr<T> where
T: 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> RefUnwindSafe for SharedPtr<T> where
T: RefUnwindSafe,

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

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

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

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

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

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

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

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

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

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