Struct Closure

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

Implementations

impl<'gc> Closure<'gc>

pub fn new( mc: &Mutation<'gc>, proto: FunctionPrototype<'gc>, environment: Option<Table<'gc>>, ) -> Result<Closure<'gc>, ClosureError>

Create a top-level closure, prototype must not have any upvalues besides _ENV.

pub fn from_parts( mc: &Mutation<'gc>, proto: Gc<'gc, FunctionPrototype<'gc>>, upvalues: Vec<UpValue<'gc>, MetricsAlloc<'gc>>, ) -> Self

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

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

pub fn load( ctx: Context<'gc>, name: Option<&str>, source: impl Read, ) -> Result<Closure<'gc>, PrototypeError>

Compile a top-level closure from source, using the globals table as the _ENV table.

pub fn load_with_env( ctx: Context<'gc>, name: Option<&str>, source: impl Read, env: Table<'gc>, ) -> Result<Closure<'gc>, PrototypeError>

Compile a top-level closure from source, using the given table as the _ENV table.

pub fn prototype(self) -> Gc<'gc, FunctionPrototype<'gc>>

pub fn upvalues(self) -> &'gc [UpValue<'gc>]

Trait Implementations

impl<'gc> Clone for Closure<'gc>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'gc> Collect for Closure<'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 Closure<'gc>

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

Formats the value using the given formatter.

impl<'gc> From<Closure<'gc>> for Function<'gc>

fn from(closure: Closure<'gc>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'gc> FromValue<'gc> for Closure<'gc>

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

impl<'gc> Hash for Closure<'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 Closure<'gc>

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

impl<'gc> IntoValue<'gc> for Closure<'gc>

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

impl<'gc> PartialEq for Closure<'gc>

fn eq(&self, other: &Closure<'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 Closure<'gc>

type Stashed = StashedClosure

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

impl<'gc> Copy for Closure<'gc>

impl<'gc> Eq for Closure<'gc>