Struct ReadRef

pub struct ReadRef<T>(/* private fields */);

The read value of a value cell. The read value is immutable, while the cell itself might change over time. It’s basically a snapshot of a value at a certain point in time.

Internally it stores a reference counted reference to a value on the heap.

Implementations

impl<T> ReadRef<T>

pub fn new_owned(value: T) -> Self

pub fn new_arc(arc: Arc<T>) -> Self

pub fn ptr_eq(&self, other: &ReadRef<T>) -> bool

pub fn ptr(&self) -> *const T

impl<T> ReadRef<T>

where T: VcValueType,

pub fn cell(read_ref: ReadRef<T>) -> Vc<T>

Returns a new cell that points to the same value as the given reference.

impl<T> ReadRef<T>

where T: VcValueType,

pub fn try_unwrap( this: Self, ) -> Result<<<T as VcValueType>::Read as VcRead<T>>::Target, Self>

Returns the inner value, if this ReadRef has exactly one strong reference.

Otherwise, an Err is returned with the same ReadRef that was passed in.

impl<T> ReadRef<T>

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: Clone,

pub fn into_owned(this: Self) -> <<T as VcValueType>::Read as VcRead<T>>::Target

This is return a owned version of the value. It potentially clones the value. The clone might be expensive. Prefer Deref to get a reference to the value.

Trait Implementations

impl<T> Clone for ReadRef<T>

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 for ReadRef<T>

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for ReadRef<T>

where T: VcValueType,

type Target = <<T as VcValueType>::Read as VcRead<T>>::Target

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de, T> Deserialize<'de> for ReadRef<T>

where T: Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> DeterministicHash for ReadRef<T>

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: DeterministicHash,

fn deterministic_hash<H: DeterministicHasher>(&self, state: &mut H)

Adds self’s bytes to the DeterministicHasher’s state, in a way that is replicatable on any platform or process run.

impl<T> Display for ReadRef<T>

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: Display,

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

Formats the value using the given formatter.

impl<T> Hash for ReadRef<T>

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T, I, J: Iterator<Item = I>> IntoIterator for &'a ReadRef<T>

where T: VcValueType, &'a <<T as VcValueType>::Read as VcRead<T>>::Target: IntoIterator<Item = I, IntoIter = J>,

type Item = I

The type of the elements being iterated over.

type IntoIter = J

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T, I: 'static, J: Iterator<Item = I>> IntoIterator for ReadRef<T>

where T: VcValueType, &'static <<T as VcValueType>::Read as VcRead<T>>::Target: IntoIterator<Item = I, IntoIter = J>,

type Item = I

The type of the elements being iterated over.

type IntoIter = ReadRefIter<T, I, J>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> Ord for ReadRef<T>

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: Ord,

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

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: PartialEq,

fn eq(&self, other: &Self) -> 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 for ReadRef<T>

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: 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

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<T> Serialize for ReadRef<T>

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TraceRawVcs for ReadRef<T>

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: TraceRawVcs,

fn trace_raw_vcs(&self, trace_context: &mut TraceRawVcsContext)

fn get_raw_vcs(&self) -> Vec<RawVc>

impl<T> ValueDebugFormat for ReadRef<T>

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: ValueDebugFormat + 'static,

fn value_debug_format(&self, depth: usize) -> ValueDebugFormatString<'_>

impl<T> Eq for ReadRef<T>

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: Eq,

impl<T> NonLocalValue for ReadRef<T>

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: NonLocalValue,

impl<T> OperationValue for ReadRef<T>

where T: VcValueType, <<T as VcValueType>::Read as VcRead<T>>::Target: OperationValue,