Struct reffers::rc::Ref

pub struct Ref<T: ?Sized + Repr, M: BitMask = u32>(_, _);

An Rc reference which has immutable access to the inner value.

It’s like a strong reference, and a immutably borrowed interior, in the same struct.

Example

use reffers::rc::Ref;
use std::collections::HashMap;

let mut z = HashMap::new();
z.insert(<Ref<_>>::new_str("Test"), 5);
assert_eq!(z.get("Test"), Some(&5));

Implementations

impl<T: ?Sized + Repr, M: BitMask> Ref<T, M>

pub fn get_ref(&self) -> Ref<T, M>

Returns a new Ref, or panics if this is not possible

Will panic in case a RefMut is currently held, or there are no more Refs available

pub fn try_get_ref(&self) -> Result<Ref<T, M>, State>

Returns a new Ref, or returns an error if there are no such references available

Will return an error in case a RefMut is currently held, or there are no more Refs available

pub fn get(&self) -> Ref<T, M>

👎 Deprecated:

Renamed to get_ref

Returns a new Ref, or panics if this is not possible

Will panic in case a RefMut is currently held, or there are no more Refs available

pub fn try_get(&self) -> Result<Ref<T, M>, State>

👎 Deprecated:

Renamed to try_get_ref

Returns a new Ref, or returns an error if there are no such references available

Will return an error in case a RefMut is currently held, or there are no more Refs available

pub fn get_weak(&self) -> Weak<T, M>

Returns a new Weak reference, or panics if there are no such references available

pub fn get_strong(&self) -> Strong<T, M>

Returns a new Strong reference, or panics if there are no such references available

pub fn try_get_weak(&self) -> Result<Weak<T, M>, State>

Returns a new Weak reference, or returns an error if there are no such references available

pub fn try_get_strong(&self) -> Result<Strong<T, M>, State>

Returns a new Strong reference, or returns an error if there are no such references available

pub fn state(&self) -> State

Returns the current state

pub fn unpoison(&self) -> Result<(), State>

Reverts poisoning

Poisoning happens when a RefMut is dropped during a panic.

impl<T, M: BitMask> Ref<T, M>

pub fn new(t: T) -> Self

Creates a new reference.

impl<M: BitMask> Ref<str, M>

pub fn new_str(t: &str) -> Self

Creates a new reference from a str.

impl<T, M: BitMask> Ref<[T], M>

pub fn new_slice<I: ExactSizeIterator<Item = T>>(t: I) -> Self

Creates a new slice reference from an iterator.

Trait Implementations

impl<T: ?Sized + Repr, M: BitMask> AsRef<T> for Ref<T, M>

fn as_ref(&self) -> &T

Performs the conversion.

impl<T: ?Sized + Repr, M: BitMask> Borrow<T> for Ref<T, M>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: ?Sized + Repr, M: BitMask> Clone for Ref<T, M>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ?Sized + Repr, M: Debug + BitMask> Debug for Ref<T, M> where
    T::Store: Debug, 

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

Formats the value using the given formatter.

impl<T: Default, M: BitMask> Default for Ref<T, M>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ?Sized + Repr, M: BitMask> Deref for Ref<T, M>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized + Repr + Display, M: BitMask> Display for Ref<T, M>

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

Formats the value using the given formatter.

impl<T: ?Sized + Repr, M: BitMask> Drop for Ref<T, M>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, M: BitMask> From<T> for Ref<T, M>

fn from(t: T) -> Self

Performs the conversion.

impl<T: ?Sized + Repr + Hash, M: BitMask> Hash for Ref<T, M>

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

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 + Repr + Ord, M: BitMask> Ord for Ref<T, M>

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) -> Self

Restrict a value to a certain interval.

impl<T: ?Sized + Repr + PartialEq, M: BitMask> PartialEq<Ref<T, M>> for Ref<T, M>

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: &Self) -> bool

This method tests for !=.

impl<T: ?Sized + Repr + PartialOrd, M: BitMask> PartialOrd<Ref<T, M>> for Ref<T, M>

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: &Self) -> bool

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

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

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

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

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

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

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

impl<T, M: BitMask> AReffic for Ref<T, M>

impl<T: ?Sized + Repr + Eq, M: BitMask> Eq for Ref<T, M>

impl<T: ?Sized + Repr, M: BitMask> StableDeref for Ref<T, M>