Struct Watcher

pub struct Watcher<'gc, C: CustomTypes<S>, S: System<C>> {
    pub entity: GcWeak<'gc, RefLock<Entity<'gc, C, S>>>,
    pub name: CompactString,
    pub value: GcWeak<'gc, RefLock<Value<'gc, C, S>>>,
}

Represents a variable whose value is being monitored.

Users can “show” or “hide” variables to create or remove watchers. These can be used by students for a number of purposes, including debugging.

Fields

entity: GcWeak<'gc, RefLock<Entity<'gc, C, S>>>

The entity associated with the variable being watched.

name: CompactString

The name of the variable being watched.

value: GcWeak<'gc, RefLock<Value<'gc, C, S>>>

The value of the variable being watched.

Trait Implementations

impl<'gc, C, S> Collect for Watcher<'gc, C, S>

where CompactString: 'static, C: Collect + CustomTypes<S>, S: Collect + System<C>,

fn needs_trace() -> bool

As an optimization, if this type can never hold a Gc pointer and trace is unnecessary to call, you may implement this method and return false. The default implementation returns true, signaling that Collect::trace must be called.

fn trace(&self, cc: &Collection)

Must call Collect::trace on all held Gc pointers. If this type holds inner types that implement Collect, a valid implementation would simply call Collect::trace on all the held values to ensure this.

impl<'gc, C: CustomTypes<S>, S: System<C>> Debug for Watcher<'gc, C, S>

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

Formats the value using the given formatter.