Struct ReadCell

pub struct ReadCell<T: ?Sized> { /* private fields */ }

A possible mutable memory location. It provides only non-mutating subset of Cell API. This allows &ReadCell<T> share value with &Cell<T> and &T alike.

Example

use std::cell::Cell;
use read_cell::ReadCell;

struct SomeStruct {
    regular_field: u8,
    special_field: Cell<u8>,
}

let my_struct = SomeStruct {
    regular_field: 0,
    special_field: Cell::new(1),
};

let new_value = 100;

let regular_field_read = ReadCell::from_ref(&my_struct.regular_field);
let special_field_read = ReadCell::from_cell(&my_struct.special_field);

assert_eq!(regular_field_read.get(), 0);
assert_eq!(special_field_read.get(), 1);

my_struct.special_field.set(new_value);
assert_eq!(special_field_read.get(), new_value);

Implementations

impl<T> ReadCell<T>

pub const fn new(value: T) -> ReadCell<T>

Creates a new ReadCell containing the given value.

Examples

use read_cell::ReadCell;

let c = ReadCell::new(5);

pub fn into_inner(self) -> T

Unwraps the value.

Examples

use read_cell::ReadCell;

let c = ReadCell::new(5);
let five = c.into_inner();

assert_eq!(five, 5);

impl<T: Copy> ReadCell<T>

pub fn get(&self) -> T

Returns a copy of the contained value.

Examples

use read_cell::ReadCell;

let c = ReadCell::new(5);

let five = c.get();

impl<T: ?Sized> ReadCell<T>

pub const fn as_ptr(&self) -> *mut T

Returns a raw pointer to the underlying data in this cell.

Examples

use read_cell::ReadCell;

let c = ReadCell::new(5);

let ptr = c.as_ptr();

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the underlying data.

This call borrows ReadCell mutably (at compile-time) which guarantees that we possess the only reference.

However be cautious: this method expects self to be mutable, which is generally not the case when using a ReadCell. If you require interior mutability by reference, consider using RefCell which provides run-time checked mutable borrows through its borrow_mut method.

Examples

use read_cell::ReadCell;

let mut c = ReadCell::new(5);
*c.get_mut() += 1;

assert_eq!(c.get(), 6);

pub fn from_ref(t: &T) -> &ReadCell<T>

Returns a &ReadCell<T> from a &T

Examples

use read_cell::ReadCell;

let slice: &[i32] = &[1, 2, 3];
let cell_slice: &ReadCell<[i32]> = ReadCell::from_ref(slice);
let slice_cell: &[ReadCell<i32>] = cell_slice.as_slice_of_cells();

assert_eq!(slice_cell.len(), 3);

pub fn from_cell(t: &Cell<T>) -> &ReadCell<T>

Returns a &ReadCell<T> from a &Cell<T>

Examples

use std::cell::Cell;
use read_cell::ReadCell;

let slice: &Cell<[i32]> = &Cell::new([1, 2, 3]);
let cell_slice: &ReadCell<[i32]> = ReadCell::from_cell(slice);
let slice_cell: &[ReadCell<i32>] = cell_slice.as_slice_of_cells();

assert_eq!(slice_cell.len(), 3);

impl<T> ReadCell<[T]>

pub fn as_slice_of_cells(&self) -> &[ReadCell<T>]

Returns a &[ReadCell<T>] from a &ReadCell<[T]>

Examples

use read_cell::ReadCell;

let slice: &[i32] = &[1, 2, 3];
let cell_slice: &ReadCell<[i32]> = ReadCell::from_ref(slice);
let slice_cell: &[ReadCell<i32>] = cell_slice.as_slice_of_cells();

assert_eq!(slice_cell.len(), 3);

impl<T, const N: usize> ReadCell<[T; N]>

pub fn as_array_of_cells(&self) -> &[ReadCell<T>; N]

Returns a &[ReadCell<T>; N] from a &ReadCell<[T; N]>

Examples

use read_cell::ReadCell;

let mut array: [i32; 3] = [1, 2, 3];
let cell_array: &ReadCell<[i32; 3]> = ReadCell::from_ref(&array);
let array_cell: &[ReadCell<i32>; 3] = cell_array.as_array_of_cells();

Trait Implementations

impl<T: Copy> Clone for ReadCell<T>

fn clone(&self) -> ReadCell<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Default> Default for ReadCell<T>

fn default() -> ReadCell<T>

Creates a ReadCell<T>, with the Default value for T.

impl<T> From<T> for ReadCell<T>

fn from(t: T) -> ReadCell<T>

Creates a new ReadCell<T> containing the given value.

impl<T: Ord + Copy> Ord for ReadCell<T>

fn cmp(&self, other: &ReadCell<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 + Copy> PartialEq for ReadCell<T>

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: Eq + Copy> Eq for ReadCell<T>