Struct shared_rc::rc::Rc

pub struct Rc<T: ?Sized, Owner: ?Sized = dyn Destruct> { /* private fields */ }

A projecting version of Rc which allows owning a containing struct but referencing a field.

Implementations

impl<'a, T: 'a> Rc<T, dyn Destruct + 'a>

pub fn new(this: T) -> Self

Constructs a new Rc<T> .

impl<'a, T: ?Sized, Owner: 'a + Sized> Rc<T, Owner>

pub fn erase_owner(this: Self) -> Rc<T, dyn Destruct + 'a>

Erases the owning type so projected Rc can be used uniformly.

impl<T: ?Sized, Owner: ?Sized> Rc<T, Owner>

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

Provides a raw pointer to the data.

pub fn downgrade(this: &Self) -> Weak<T, Owner>

Creates a new Weak pointer to this projected field.

pub fn owner(this: &Self) -> Rc<Owner>

Gets a reference to the owning allocation.

This returns a clone of the owning Rc, so it cannot return a unique reference. If you want to take unique ownership, use into_owner instead.

pub fn into_owner(this: Self) -> Rc<Owner>

Consumes this projected field and returns the owning allocation.

pub fn project<U: ?Sized>(
    this: Self,
    projection: impl FnOnce(&T) -> &U
) -> Rc<U, Owner>

Projects this allocation to a field.

Note that the projected field is not required to actually be owned by the owner; it could be any longer-lived reference.

pub fn ptr_eq(lhs: &Self, rhs: &Self) -> bool

Returns true if the two Rcs point to the same allocation (in a vein similar to ptr::eq).

impl<T: ?Sized, Owner: ?Sized> Rc<T, Owner>

pub fn unsize<U: ?Sized, F>(this: Self, with: Coercion<T, U, F>) -> Rc<U, Owner>where
    T: Sized,
    F: FnOnce(*const T) -> *const U,

Available on crate feature unsize only.

Convert this pointer with an unsizing coercion (e.g. from T to dyn Trait or [T; N] to [T]).

pub fn unsize_owner<Pwner: ?Sized, F>(
    this: Self,
    with: Coercion<Owner, Pwner, F>
) -> Rc<T, Pwner>where
    Owner: Sized,
    F: FnOnce(*const Owner) -> *const Pwner,

Available on crate feature unsize only.

Convert this pointer with an unsizing coercion of the owner (e.g. from T to dyn Trait or [T; N] to [T]).

Trait Implementations

impl<T: ?Sized, Owner: ?Sized> AsRef<T> for Rc<T, Owner>

fn as_ref(&self) -> &T

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

impl<T: ?Sized, Owner: ?Sized> Borrow<T> for Rc<T, Owner>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: Clone + ?Sized, Owner: Clone + ?Sized> Clone for Rc<T, Owner>

fn clone(&self) -> Rc<T, Owner>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, U: ?Sized, Owner: ?Sized> CoerciblePtr<U> for Rc<T, Owner>

Available on crate feature unsize only.

type Pointee = T

The type we point to. This influences which kinds of unsizing are possible.

type Output = Rc<U, Owner>

The output type when unsizing the pointee to U.

fn as_sized_ptr(&mut self) -> *mut Self::Pointee

Get the raw inner pointer.

unsafe fn replace_ptr(self, ptr: *mut U) -> Self::Output

Replace the container inner pointer with an unsized version.

impl<T: ?Sized, Owner: ?Sized> Debug for Rc<T, Owner>where
    T: Debug,

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

Formats the value using the given formatter.

impl<T: Default> Default for Rc<T, T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: 'static + Default> Default for Rc<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ?Sized, Owner: ?Sized> Deref for Rc<T, Owner>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: ?Sized, Owner: ?Sized> Display for Rc<T, Owner>where
    T: Display,

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

Formats the value using the given formatter.

impl<T: ?Sized, Owner: ?Sized> Error for Rc<T, Owner>where
    T: Error,

Available on crate feature std only.

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide(&'a self, demand: &mut Demand<'a>)

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

Provides type based access to context intended for error reports.

impl<T: ?Sized, Owner: ?Sized> From<Rc<T, Owner>> for Rc<Owner>

fn from(this: Rc<T, Owner>) -> Self

Converts to this type from the input type.

impl<'a, T: ?Sized, Owner: 'a> From<Rc<T, Owner>> for Rc<T, dyn Destruct + 'a>

fn from(this: Rc<T, Owner>) -> Self

Converts to this type from the input type.

impl<T: ?Sized> From<Rc<T>> for Rc<T, T>

fn from(owner: Rc<T>) -> Self

Converts to this type from the input type.

impl<T, Owner: ?Sized> From<T> for Rc<T, Owner>where
    Rc<T, Owner>: From<Rc<T, T>>,

fn from(this: T) -> Self

Converts to this type from the input type.

impl<T: ?Sized, Owner: ?Sized> Hash for Rc<T, Owner>where
    T: Hash,

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,

Feeds a slice of this type into the given Hasher.

impl<T: ?Sized, Owner: ?Sized> Ord for Rc<T, Owner>where
    T: Ord,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: ?Sized, Owner: ?Sized> PartialEq<Rc<T, Owner>> for Rc<T, Owner>where
    T: PartialEq,

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: ?Sized, Owner: ?Sized> PartialOrd<Rc<T, Owner>> for Rc<T, Owner>where
    T: PartialOrd,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: ?Sized, Owner: ?Sized> Pointer for Rc<T, Owner>

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

Formats the value using the given formatter.

impl<T: ?Sized, Owner: ?Sized> Eq for Rc<T, Owner>where
    T: Eq,

impl<T: ?Sized, Owner: ?Sized> Send for Rc<T, Owner>where
    Rc<T>: Send,

impl<T: ?Sized, Owner: ?Sized> Sync for Rc<T, Owner>where
    Rc<T>: Sync,

impl<T: ?Sized, Owner: ?Sized> UnwindSafe for Rc<T, Owner>where
    for<'a> &'a T: UnwindSafe,
    Rc<Owner>: UnwindSafe,

Available on crate feature std only.