Struct Effects 

pub struct Effects { /* private fields */ }

Captured effects from an operation. This struct can be used to return Effects from a turbo-tasks function and apply them later.

Cell semantics

Effects uses cell = "new": every producer re-execution allocates a fresh cell value and the prior cell is dropped. Cell-level dedup of Effects is given up; per-key dedup at apply time is provided by EffectStateStorage’s state machine (see EffectStateStorage::run_apply), which short-circuits when storage already holds Applied { value_hash } matching the new hash.

Effects::apply is idempotent and safe to call multiple times on the same value — the state machine in run_apply ensures each underlying side effect runs at most once per stored (key, value_hash) pair across all callers.

Implementations

impl Effects

pub fn cell(self) -> Vc<Self>

Places a value in a cell of the current task.

Cell is selected based on the value type and call order of cell.

pub fn resolved_cell(self) -> ResolvedVc<Self>

Places a value in a cell of the current task. Returns a ResolvedVc.

Cell is selected based on the value type and call order of cell.

Trait Implementations

impl Eq for Effects

impl NonLocalValue for Effects

impl PartialEq for Effects

PartialEq/Eq are compat shims so containing structs (which derive PartialEq/Eq via turbo_tasks::value) can still embed Effects. The actual cell-update strategy for Effects itself is cell = "new" — see the doc-comment above — so this PartialEq is not consulted for Effects cells. We always return false to match cell = "new" semantics for the wrapper structs (they should also refresh on every producer run).

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 ShrinkToFit for Effects

fn shrink_to_fit(&mut self)

impl TraceRawVcs for Effects

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

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

impl Upcast<Box<dyn ValueDebug>> for Effects

impl UpcastStrict<Box<dyn ValueDebug>> for Effects

impl ValueDebug for Effects

fn dbg_depth<'a>( &'a self, depth: usize, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'a>>

Like dbg, but with a depth limit.

fn dbg(&self) -> Pin<Box<dyn Future<Output = Result<String>> + Send + '_>>

impl ValueDebugFormat for Effects

Available on debug-assertions enabled only.

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

impl VcValueType for Effects

type Read = VcDefaultRead<Effects>

How to read the value.

type CellMode = VcCellNewMode<Effects>

How to update cells of this value type.

fn get_value_type_id() -> ValueTypeId

Returns the type id of the value type.

fn has_serialization() -> bool