Struct archery::shared_pointer::SharedPointer

pub struct SharedPointer<T, P> where
    P: SharedPointerKind,  { /* fields omitted */ }

Pointer to shared data with reference-counting.

The type parameter P is a type constructor of the underlying pointer type, offering a way to abstraction over Rc and Arc smart pointers. This allows you to create data structures where the pointer type is parameterizable, so you can avoid the overhead of Arc when you don’t need to share data across threads.

Example

Declare a data structure with the pointer kind as a type parameter bounded by SharedPointerKind:

use archery::*;

struct KeyValuePair<K, V, P: SharedPointerKind> {
    pub key: SharedPointer<K, P>,
    pub value: SharedPointer<V, P>,
}

impl<K, V, P: SharedPointerKind> KeyValuePair<K, V, P> {
    fn new(key: K, value: V) -> KeyValuePair<K, V, P> {
        KeyValuePair {
            key: SharedPointer::new(key),
            value: SharedPointer::new(value),
        }
    }
}

To use it just plug-in the kind of pointer you want:

let pair: KeyValuePair<_, _, RcK> =
    KeyValuePair::new("António Variações", 1944);

assert_eq!(*pair.value, 1944);

Methods

impl<T, P> SharedPointer<T, P> where
    P: SharedPointerKind, 

pub fn new(v: T) -> SharedPointer<T, P>

pub fn try_unwrap(this: SharedPointer<T, P>) -> Result<T, SharedPointer<T, P>>

pub fn get_mut(this: &mut SharedPointer<T, P>) -> Option<&mut T>

pub fn strong_count(this: &Self) -> usize

pub fn ptr_eq<PO: SharedPointerKind>(
    this: &SharedPointer<T, P>,
    other: &SharedPointer<T, PO>
) -> bool

impl<T, P> SharedPointer<T, P> where
    T: Clone,
    P: SharedPointerKind, 

pub fn make_mut(this: &mut SharedPointer<T, P>) -> &mut T

Trait Implementations

impl<T, P> From<T> for SharedPointer<T, P> where
    P: SharedPointerKind, 

fn from(other: T) -> SharedPointer<T, P>

Performs the conversion.

impl<T, P> From<Box<T>> for SharedPointer<T, P> where
    P: SharedPointerKind, 

fn from(v: Box<T>) -> SharedPointer<T, P>

Performs the conversion.

impl<T, P> Drop for SharedPointer<T, P> where
    P: SharedPointerKind, 

fn drop(&mut self)

Executes the destructor for this type.

impl<T, P> Ord for SharedPointer<T, P> where
    T: Ord,
    P: SharedPointerKind, 

fn cmp(&self, other: &SharedPointer<T, P>) -> 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) -> Self

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

Restrict a value to a certain interval.

impl<T, P, PO> PartialOrd<SharedPointer<T, PO>> for SharedPointer<T, P> where
    T: PartialOrd,
    P: SharedPointerKind,
    PO: SharedPointerKind, 

fn partial_cmp(&self, other: &SharedPointer<T, PO>) -> Option<Ordering>

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

fn lt(&self, other: &SharedPointer<T, PO>) -> bool

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

fn le(&self, other: &SharedPointer<T, PO>) -> bool

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

fn gt(&self, other: &SharedPointer<T, PO>) -> bool

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

fn ge(&self, other: &SharedPointer<T, PO>) -> bool

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

impl<T, P, PO> PartialEq<SharedPointer<T, PO>> for SharedPointer<T, P> where
    T: PartialEq,
    P: SharedPointerKind,
    PO: SharedPointerKind, 

fn eq(&self, other: &SharedPointer<T, PO>) -> bool

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

fn ne(&self, other: &SharedPointer<T, PO>) -> bool

This method tests for !=.

impl<T, P> Default for SharedPointer<T, P> where
    T: Default,
    P: SharedPointerKind, 

fn default() -> SharedPointer<T, P>

Returns the "default value" for a type.

impl<T, P> Clone for SharedPointer<T, P> where
    P: SharedPointerKind, 

fn clone(&self) -> SharedPointer<T, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, P> Eq for SharedPointer<T, P> where
    T: Eq,
    P: SharedPointerKind, 

impl<T, P> AsRef<T> for SharedPointer<T, P> where
    P: SharedPointerKind, 

fn as_ref(&self) -> &T

Performs the conversion.

impl<T, P> Deref for SharedPointer<T, P> where
    P: SharedPointerKind, 

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T, P> Display for SharedPointer<T, P> where
    T: Display,
    P: SharedPointerKind, 

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

Formats the value using the given formatter.

impl<T, P> Debug for SharedPointer<T, P> where
    T: Debug,
    P: SharedPointerKind, 

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

Formats the value using the given formatter.

impl<T, P> Hash for SharedPointer<T, P> where
    T: Hash,
    P: SharedPointerKind, 

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, P> Pointer for SharedPointer<T, P> where
    P: SharedPointerKind, 

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

Formats the value using the given formatter.

impl<T, P> Borrow<T> for SharedPointer<T, P> where
    P: SharedPointerKind, 

fn borrow(&self) -> &T

Immutably borrows from an owned value.