Struct gc_sequence::SequenceFn

#[must_use = "sequences do nothing unless stepped"]
pub struct SequenceFn<F>(_);

Methods

impl<F> SequenceFn<F>

pub fn new(f: F) -> SequenceFn<F>

Trait Implementations

impl<'gc, F, R> Sequence<'gc> for SequenceFn<F> where
    F: 'static + FnOnce(MutationContext<'gc, '_>) -> R, 

type Output = R

fn step(&mut self, mc: MutationContext<'gc, '_>) -> Option<Self::Output>

impl<F> Drop for SequenceFn<F>

fn drop(&mut self)

Executes the destructor for this type.

impl<F: Debug> Debug for SequenceFn<F>

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

Formats the value using the given formatter.

impl<F> Collect for SequenceFn<F> where
    Option<StaticCollect<F>>: Collect, 

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: CollectionContext)

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.