Struct OwnedRef 

pub struct OwnedRef<T> { /* private fields */ }

An owning reference to a shared owned object. Each instance must call release before being dropped. OwnedRef will panic on Drop in debug builds if it has not been released.

Implementations

impl<T> OwnedRef<T>

pub fn new(value: T) -> Self

pub fn new_cyclic<F>(data_fn: F) -> Self

where F: FnOnce(WeakRef<T>) -> T,

pub fn as_ptr(this: &Self) -> *const T

Provides a raw pointer to the data.

See Arc::as_ptr

pub fn ptr_eq(this: &Self, other: &Self) -> bool

Returns true if the two objects point to the same allocation

pub fn downgrade(this: &Self) -> WeakRef<T>

Produce a WeakRef from a OwnedRef.

pub fn temp(this: &Self) -> TempRef<'_, T>

Produce a TempRef from a OwnedRef. As an OwnedRef exists at the time of the creation, this cannot fail.

impl<T: Releasable> OwnedRef<T>

pub fn take(this: &mut Self) -> Option<ReleaseGuard<T>>

Take the releasable from the OwnedRef. Returns None if the OwnedRef is not the last reference to the data.

Trait Implementations

impl<T> AsRef<T> for OwnedRef<T>

fn as_ref(&self) -> &T

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

impl<T> Borrow<T> for OwnedRef<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: Debug> Debug for OwnedRef<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for OwnedRef<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for OwnedRef<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, T> From<&'a OwnedRef<T>> for TempRef<'a, T>

fn from(owner: &'a OwnedRef<T>) -> Self

Converts to this type from the input type.

impl<T> From<&OwnedRef<T>> for WeakRef<T>

fn from(owner: &OwnedRef<T>) -> Self

Converts to this type from the input type.

impl<'a, T> From<&OwnedRef<T>> for WeakRefKey<T>

fn from(owned_ref: &OwnedRef<T>) -> Self

Converts to this type from the input type.

impl<'a, T> From<&'a mut OwnedRef<T>> for TempRef<'a, T>

fn from(owner: &'a mut OwnedRef<T>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for OwnedRef<T>

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

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> Ord for OwnedRef<T>

fn cmp(&self, other: &OwnedRef<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> PartialEq<TempRef<'_, T>> for OwnedRef<T>

fn eq(&self, other: &TempRef<'_, 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: PartialEq> PartialEq for OwnedRef<T>

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

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

fn release<'a>(self, c: Self::Context<'a>)

Release the OwnedRef. If this is the last instance, this method will block until all TempRef instances are dropped, and will release the underlying object.

type Context<'a> = <T as Releasable>::Context<'a>

impl<T: Releasable> Share for OwnedRef<T>

fn share(&self) -> Self

Clone the OwnedRef. Both the current and the new reference needs to be released.

impl<T: Eq> Eq for OwnedRef<T>