Struct Callback

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

Implementations

impl<'gc> Callback<'gc>

pub fn new<C: CallbackFn<'gc> + 'gc>(mc: &Mutation<'gc>, callback: C) -> Self

pub fn from_fn<F>(mc: &Mutation<'gc>, call: F) -> Callback<'gc>

where F: 'static + Fn(Context<'gc>, Execution<'gc, '_>, Stack<'gc, '_>) -> Result<CallbackReturn<'gc>, Error<'gc>>,

pub fn from_fn_with<R, F>(mc: &Mutation<'gc>, root: R, call: F) -> Callback<'gc>

where R: 'gc + Collect, F: 'static + Fn(&R, Context<'gc>, Execution<'gc, '_>, Stack<'gc, '_>) -> Result<CallbackReturn<'gc>, Error<'gc>>,

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

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

pub fn call( self, ctx: Context<'gc>, exec: Execution<'gc, '_>, stack: Stack<'gc, '_>, ) -> Result<CallbackReturn<'gc>, Error<'gc>>

Trait Implementations

impl<'gc> Clone for Callback<'gc>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn from(callback: Callback<'gc>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'gc> FromValue<'gc> for Callback<'gc>

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

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

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

impl<'gc> IntoValue<'gc> for Callback<'gc>

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

impl<'gc> PartialEq for Callback<'gc>

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

type Stashed = StashedCallback

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

impl<'gc> Copy for Callback<'gc>

impl<'gc> Eq for Callback<'gc>