Struct Thread

pub struct Thread<'gc>(/* private fields */);

Implementations

impl<'gc> Thread<'gc>

pub fn new(ctx: Context<'gc>) -> Thread<'gc>

pub fn from_inner(inner: Gc<'gc, ThreadInner<'gc>>) -> Self

pub fn into_inner(self) -> Gc<'gc, ThreadInner<'gc>>

pub fn mode(self) -> ThreadMode

pub fn start( self, ctx: Context<'gc>, function: Function<'gc>, args: impl IntoMultiValue<'gc>, ) -> Result<(), BadThreadMode>

If this thread is Stopped, start a new function with the given arguments.

pub fn start_suspended( self, mc: &Mutation<'gc>, function: Function<'gc>, ) -> Result<(), BadThreadMode>

If this thread is Stopped, start a new suspended function.

pub fn take_result<T: FromMultiValue<'gc>>( self, ctx: Context<'gc>, ) -> Result<Result<T, Error<'gc>>, BadThreadMode>

If the thread is in the Result mode, take the returned (or yielded) values. Moves the thread back to the Stopped (or Suspended) mode.

pub fn resume( self, ctx: Context<'gc>, args: impl IntoMultiValue<'gc>, ) -> Result<(), BadThreadMode>

If the thread is in Suspended mode, resume it.

pub fn resume_err( self, mc: &Mutation<'gc>, error: Error<'gc>, ) -> Result<(), BadThreadMode>

If the thread is in Suspended mode, cause an error wherever the thread was suspended.

pub fn reset(self, mc: &Mutation<'gc>) -> Result<(), BadThreadMode>

If this thread is in any other mode than Running, reset the thread completely and restore it to the Stopped state.

Trait Implementations

impl<'gc> Clone for Thread<'gc>

fn clone(&self) -> Thread<'gc>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'gc> Collect for Thread<'gc>

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> Debug for Thread<'gc>

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

Formats the value using the given formatter.

impl<'gc> From<Thread<'gc>> for Value<'gc>

fn from(v: Thread<'gc>) -> Value<'gc>

Converts to this type from the input type.

impl<'gc> FromValue<'gc> for Thread<'gc>

fn from_value(_: Context<'gc>, value: Value<'gc>) -> Result<Self, TypeError>

impl<'gc> Hash for Thread<'gc>

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

Feeds this value into the given Hasher.

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<'a, 'gc> IntoValue<'gc> for &'a Thread<'gc>

fn into_value(self, ctx: Context<'gc>) -> Value<'gc>

impl<'gc> IntoValue<'gc> for Thread<'gc>

fn into_value(self, _: Context<'gc>) -> Value<'gc>

impl<'gc> PartialEq for Thread<'gc>

fn eq(&self, other: &Thread<'gc>) -> 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<'gc> Stashable<'gc> for Thread<'gc>

type Stashed = StashedThread

fn stash(self, roots: &DynamicRootSet<'gc>, mc: &Mutation<'gc>) -> Self::Stashed

impl<'gc> Copy for Thread<'gc>

impl<'gc> Eq for Thread<'gc>