Struct GcRoot 

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

An RAII guard that pins an OperationVc’s task against garbage collection.

Implementations

impl<T: ?Sized> GcRoot<T>

pub fn pin(tt: Arc<dyn TurboTasksApi>, vc: OperationVc<T>) -> Self

Pins vc’s task, returning a guard that unpins it on drop.

Trait Implementations

impl<T: ?Sized> Borrow<OperationVc<T>> for GcRoot<T>

Lets a collection keyed on guards be queried with the bare operation: Borrow plus the matching Hash/Eq impls give OperationVc<T>: Equivalent<GcRoot<T>>, so e.g. IndexSet<GcRoot<T>>::swap_remove accepts an &OperationVc<T>.

fn borrow(&self) -> &OperationVc<T>

Immutably borrows from an owned value.

impl<T: ?Sized> Clone for GcRoot<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized> Debug for GcRoot<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for GcRoot<T>

A guard derefs to the operation it pins, so OperationVc’s own methods can be called on it directly and *guard recovers the operation itself.

type Target = OperationVc<T>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized> Drop for GcRoot<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T: ?Sized> Eq for GcRoot<T>

impl<T: ?Sized> Hash for GcRoot<T>

fn hash<H: Hasher>(&self, state: &mut H)

Hashes the pinned operation, consistently with PartialEq, so a guard can be looked up in a set by the OperationVc it pins (see the Borrow impl).

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<T: NonLocalValue + ?Sized> NonLocalValue for GcRoot<T>

Safety: mirrors the OperationVc impl — a GcRoot holds no task-local data beyond the operation it pins.

impl<T: ?Sized + Send> OperationValue for GcRoot<T>

Safety: a GcRoot contains exactly one OperationVc and no Vc or ResolvedVc, which is what OperationValue asserts.

impl<T: ?Sized> PartialEq for GcRoot<T>

fn eq(&self, other: &Self) -> bool

Compares the pinned operation only. Two guards for the same operation are interchangeable as far as reachability is concerned, even though each holds its own pin.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: ?Sized> TraceRawVcs for GcRoot<T>

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

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