Struct RefCounter

pub struct RefCounter { /* private fields */ }

RefCounter is a data-structure designed specifically for internal use in UniquePointer allowing reference counts to be shared across clones of UniquePointer.

RefCounter uses relatively obscure rust techniques under the hood to allow writing in non-mut references in strategic occasions such as incrementing its reference count within its Clone implementation.

Finally, write, reset, incr, incr_by, decr, decr_by allows RefCounter instances to modify non-mut instances &RefCounter of RefCounter such that implementors don’t need to resort to UniquePointer::unlock_reference.

Implementations

impl RefCounter

pub fn null() -> RefCounter

new creates a new RefCounter with its internal state equivalent to zero.

pub fn new() -> RefCounter

new creates a new RefCounter with the value 1

pub fn reset(&self)

reset resets a RefCounter to one which is the equivalent state of a new.

pub fn incr(&self)

incr increments the RefCounter by one

pub fn incr_by(&self, by: usize)

incr_by increments the RefCounter

pub fn decr(&self)

decr decrements the RefCounter by one

pub fn decr_by(&self, by: usize)

decr_by decrements the RefCounter

pub fn drain(&mut self)

drain deallocates the memory used by a RefCounter resetting its internals so as to behave as though it has been written 0.

pub fn read(&self) -> usize

pub fn write(&mut self, data: usize)

write writes a usize into a RefCounter as opposed to incrementing or decrementing it.

pub fn inner_ref<'c>(&self) -> &'c usize

inner_ref returns a reference to the internal data of a RefCounter. Writing to the memory area if not already allocated.

pub fn inner_mut<'c>(&mut self) -> &'c mut usize

inner_mut returns a mutable reference to the internal data of a RefCounter. Writing to the memory area if not already allocated.

Methods from Deref<Target = usize>

pub const MIN: usize = 0usize

pub const MAX: usize = 18_446_744_073_709_551_615usize

pub const BITS: u32 = 64u32

Trait Implementations

impl AddAssign<usize> for RefCounter

fn add_assign(&mut self, other: usize)

Performs the += operation.

impl AsMut<usize> for RefCounter

fn as_mut(&mut self) -> &mut usize

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

impl AsRef<usize> for RefCounter

fn as_ref(&self) -> &usize

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

impl Clone for RefCounter

fn clone(&self) -> RefCounter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RefCounter

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

Formats the value using the given formatter.

impl Deref for RefCounter

type Target = usize

The resulting type after dereferencing.

fn deref(&self) -> &usize

Dereferences the value.

impl DerefMut for RefCounter

fn deref_mut(&mut self) -> &mut usize

Mutably dereferences the value.

impl Display for RefCounter

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

Formats the value using the given formatter.

impl Drop for RefCounter

fn drop(&mut self)

Executes the destructor for this type.

impl From<usize> for RefCounter

fn from(refs: usize) -> RefCounter

Converts to this type from the input type.

impl Hash for RefCounter

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 Ord for RefCounter

fn cmp(&self, other: &RefCounter) -> 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 PartialEq<usize> for RefCounter

fn eq(&self, other: &usize) -> 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 PartialEq for RefCounter

fn eq(&self, other: &RefCounter) -> 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 PartialOrd<usize> for RefCounter

fn partial_cmp(&self, other: &usize) -> 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 PartialOrd for RefCounter

fn partial_cmp(&self, other: &RefCounter) -> 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 SubAssign<usize> for RefCounter

fn sub_assign(&mut self, other: usize)

Performs the -= operation.

impl Eq for RefCounter