Skip to main content

SharedRef

Struct SharedRef 

Source
pub struct SharedRef<T>(/* private fields */)
where
    T: Shared;
Expand description

Wrapper around a C++ shared_ptr. The shared_ptr is assumed to contain a value and may not be null.

Implementations§

Source§

impl<T> SharedRef<T>
where T: Shared,

Source

pub fn assert_use_count_eq(&self, expected: usize)

Asserts that the number of references to the shared inner value is equal to the expected count.

This function relies on the C++ method std::shared_ptr::use_count(), which usually performs a relaxed load. This function will repeatedly call use_count() until it returns the expected value, for up to one second. Therefore it should probably not be used in performance critical code.

Trait Implementations§

Source§

impl<T> AsRef<T> for SharedRef<T>
where T: Shared,

Source§

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<T> Borrow<T> for SharedRef<T>
where T: Shared,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> Clone for SharedRef<T>
where T: Shared,

Source§

fn clone(&self) -> SharedRef<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Debug for SharedRef<T>
where T: Debug + Shared,

Source§

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

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

impl<T> Deref for SharedRef<T>
where T: Shared,

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &<SharedRef<T> as Deref>::Target

Dereferences the value.
Source§

impl<T> From<SharedRef<T>> for SharedPtr<T>
where T: Shared,

Source§

fn from(shared_ref: SharedRef<T>) -> SharedPtr<T>

Converts to this type from the input type.
Source§

impl<T> From<UniqueRef<T>> for SharedRef<T>
where T: Shared,

Source§

fn from(unique_ref: UniqueRef<T>) -> SharedRef<T>

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<T> Freeze for SharedRef<T>
where SharedPtrBase<T>: Freeze,

§

impl<T> RefUnwindSafe for SharedRef<T>
where SharedPtrBase<T>: RefUnwindSafe,

§

impl<T> Send for SharedRef<T>
where SharedPtrBase<T>: Send,

§

impl<T> Sync for SharedRef<T>
where SharedPtrBase<T>: Sync,

§

impl<T> Unpin for SharedRef<T>
where SharedPtrBase<T>: Unpin,

§

impl<T> UnsafeUnpin for SharedRef<T>
where SharedPtrBase<T>: UnsafeUnpin,

§

impl<T> UnwindSafe for SharedRef<T>
where SharedPtrBase<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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

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

Source§

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

Source§

type Error = !

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>,

Source§

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.