Struct Pins 

pub struct Pins { /* private fields */ }

A set of node ids to treat as extra mark roots for ScriptedDom::collect — nodes the document tree no longer reaches but that must survive anyway. The host pins a node while script can still reach it (it holds a reflector), so a pinned orphan and its whole connected component are spared; unpinning it makes it collectable. The DOM only sees a pin set; the host’s word for these is “reflector pins” (it pins on minting a reflector and retires the ones the engine reports dead). Engine-agnostic — it traffics only in NodeId, naming no engine type.

Implementations

impl Pins

pub fn new() -> Self

An empty pin set.

pub fn pin(&mut self, id: NodeId)

Pin id (script can still reach it). Idempotent.

pub fn unpin(&mut self, id: NodeId) -> bool

Drop the pin for id. Returns true if it had been pinned (an id never pinned here is a harmless no-op).

pub fn retire_dead(&mut self, dead: impl IntoIterator<Item = NodeId>) -> usize

Retire a batch of now-dead ids (the host maps the engine’s drain_dead_reflectors output through NodeId::from_raw first), unpinning each. Returns how many were actually pinned.

pub fn is_pinned(&self, id: NodeId) -> bool

Whether id is currently pinned.

pub fn iter(&self) -> impl Iterator<Item = NodeId> + '_

The pinned ids — pass to ScriptedDom::collect as the extra roots.

pub fn len(&self) -> usize

Number of pinned ids.

pub fn is_empty(&self) -> bool

Whether nothing is pinned.

pub fn clear(&mut self)

Drop every pin (document teardown).

Trait Implementations

impl Clone for Pins

fn clone(&self) -> Pins

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pins

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

Formats the value using the given formatter.

impl Default for Pins

fn default() -> Pins

Returns the “default value” for a type.