Struct gdnative_async::Context

pub struct Context { /* private fields */ }

Context for creating yield-like futures in async methods.

Implementations

impl Context

pub fn until_resume(&self) -> Yield<Variant>

Returns a future that waits until the corresponding FunctionState object is manually resumed from GDScript, and yields the argument to resume or Nil if nothing is passed.

Calling this function will put the associated FunctionState-like object in resumable state, and will make it emit a resumable signal if it isn’t in that state already.

Only the most recent future created from this Context is guaranteed to resolve upon a resume call. If any previous futures weren’t awaited to completion, they are no longer guaranteed to resolve, and have unspecified, but safe behavior when polled.

pub fn signal<C>(
    &self,
    obj: TRef<'_, C>,
    signal: &str
) -> Result<Yield<Vec<Variant>>, GodotError>where
    C: SubClass<Object>,

Returns a future that waits until the specified signal is emitted, if connection succeeds. Yields any arguments emitted with the signal.

Only the most recent future created from this Context is guaranteed to resolve when the signal is emitted. If any previous futures weren’t awaited to completion, they are no longer guaranteed to resolve, and have unspecified, but safe behavior when polled.

Errors

If connection to the signal failed.