Struct RawVc 

pub struct RawVc(/* private fields */);

A type-erased representation of Vc.

Type erasure reduces the monomorphization (and therefore binary size and compilation time) required to support Vc.

This type is heavily used within the Backend trait, but should otherwise be treated as an internal implementation detail of turbo-tasks.

Representation

RawVc is one of three logical variants (see RawVcUnpacked) bit-packed into a single NonZeroU64.

Bit 31 is the discriminator between a local output and a task variant; the two task variants are then told apart by whether the CellId field (the high 32 bits) is zero — which is unambiguous because every CellId is non-zero.

bit31 = 1                  LocalOutput: 1<<31 | transient(1) | ExecutionId(16) << 1 | LocalTaskId(32) << 32
bit31 = 0, bits32..63 == 0 TaskOutput:  TaskId(31)
bit31 = 0, bits32..63 != 0 TaskCell:    TaskId(31) | CellId(32) << 32

Implementations

impl RawVc

pub fn task_output(task: TaskId) -> Self

Packs the synchronous return value of a task. The word is simply the TaskId value: bit 31 clear (a task variant) and the cell field zero (no cell).

pub fn task_cell(task: TaskId, cell: CellId) -> Self

Packs a pointer to a specific cell within a task: the TaskId in the low bits and the non-zero CellId in the high 32 bits.

pub fn local_output( execution_id: ExecutionId, local_task_id: LocalTaskId, persistence: TaskPersistence, ) -> Self

Packs the synchronous return value of a local task, marked by bit 31.

pub fn unpack(self) -> RawVcUnpacked

Unpacks into the logical RawVcUnpacked enum for matching.

pub fn as_task_output(self) -> Option<TaskId>

Returns the TaskId if this is a TaskOutput, otherwise None.

Prefer this over unpack when a caller only cares about the TaskOutput case: it reads just the discriminator and the task bits.

pub fn as_task_cell(self) -> Option<(TaskId, CellId)>

Returns the (TaskId, CellId) pair if this is a TaskCell, otherwise None.

Prefer this over unpack when a caller only cares about the TaskCell case: it reads just the discriminator, the task bits, and the cell bits.

pub fn as_local_output( self, ) -> Option<(ExecutionId, LocalTaskId, TaskPersistence)>

Returns the (ExecutionId, LocalTaskId, TaskPersistence) triple if this is a LocalOutput, otherwise None.

Prefer this over unpack when a caller only cares about the LocalOutput case.

impl RawVc

pub fn is_resolved(&self) -> bool

pub fn is_local_output(&self) -> bool

pub fn is_transient(&self) -> bool

Returns true if the task this RawVc reads from cannot be serialized and will not be stored in the filesystem cache.

See TaskPersistence for more details.

pub async fn to_non_local(self) -> Result<RawVc>

Convert a potentially local RawVc into a non-local RawVc. This is a subset of resolution resolution, because the returned RawVc can be a TaskOutput.

pub fn try_get_task_id(&self) -> Option<TaskId>

pub fn try_get_type_id(&self) -> Option<ValueTypeId>

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for RawVc

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for RawVc

fn clone(&self) -> RawVc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CollectiblesSource for RawVc

This implementation of CollectiblesSource assumes that self is a RawVc::TaskOutput.

fn peek_collectibles<T: VcValueTrait + ?Sized>(self) -> AutoSet<ResolvedVc<T>>

fn take_collectibles<T: VcValueTrait + ?Sized>(self) -> AutoSet<ResolvedVc<T>>

fn drop_collectibles<T: VcValueTrait + ?Sized>(self)

impl Debug for RawVc

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for RawVc

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl<'de> Deserialize<'de> for RawVc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RawVc

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

Formats the value using the given formatter.

impl Encode for RawVc

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl From<CurrentCellRef> for RawVc

fn from(cell: CurrentCellRef) -> Self

Converts to this type from the input type.

impl<T> From<RawVc> for Vc<T>

where T: ?Sized,

fn from(node: RawVc) -> Self

Converts to this type from the input type.

impl Hash for RawVc

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 PartialEq for RawVc

fn eq(&self, other: &RawVc) -> 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 Serialize for RawVc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TraceRawVcs for RawVc

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

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

impl<T> TryFrom<RawVc> for OperationVc<T>

where T: ?Sized,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(raw: RawVc) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<RawVc> for ResolvedVc<T>

where T: ?Sized,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(raw: RawVc) -> Result<Self>

Performs the conversion.

impl Copy for RawVc

impl Eq for RawVc

impl StructuralPartialEq for RawVc