Skip to main content

HostCallKind

Enum HostCallKind 

Source
pub enum HostCallKind {
    Spawn(MaterializedCE),
    Register(MaterializedCE),
    Attach {
        parent: Option<ComponentId>,
        child: ComponentId,
    },
    RegisterHandler {
        scope: ComponentId,
        signal_kind: SignalKind,
        name: Option<String>,
        handler: Value,
    },
    Query {
        selector: String,
        scope: Option<ComponentId>,
        multiple: bool,
    },
    ReplTree {
        value: Value,
        max_depth: Option<usize>,
    },
    ReplDump {
        value: Value,
    },
    ReplHelp,
    ReplClear,
    AudioClipInstance {
        source: ComponentId,
        start_beat: Option<f64>,
        stop_beat: Option<f64>,
    },
    InvokeComponentMethod {
        id: ComponentId,
        component_type: String,
        method: String,
        args: Vec<Value>,
    },
}
Expand description

Operations the evaluator can request from the host.

Variants§

§

Spawn(MaterializedCE)

Spawn a component tree and return its root ComponentId. Used for fire-and-forget root emissions (currently unused by the evaluator — top-level CEs are still pushed as IntentValue for now).

§

Register(MaterializedCE)

Create the component tree in the world but do not attach it to a parent and do not run init. Returns the root ComponentId. The caller (typically let x = CE) holds the id as a ComponentObject and decides where/when to splice the subtree in.

§

Attach

Attach a previously Registered (or Spawned) detached subtree to a parent and run the deferred init walk. With parent: None the subtree is initialised in place as a world root.

Fields

§

RegisterHandler

Register an MMS function as a scoped signal handler. The host installs the closure and replies with HostValue::Null.

Fields

§signal_kind: SignalKind
§handler: Value
§

Query

Query the live ECS world. scope = None means search from the world’s canonical roots; scope = Some(id) restricts the search to the subtree rooted at id. multiple selects between query_all (true, returns ComponentList) and query (false, returns the first match as Component or Null if none).

Fields

§selector: String
§multiple: bool
§

ReplTree

Fields

§value: Value
§max_depth: Option<usize>
§

ReplDump

Fields

§value: Value
§

ReplHelp

§

ReplClear

§

AudioClipInstance

Create a new AudioClipComponent that shares source’s decoded asset but gets its own playhead (RT instance). Returns the new component’s id, detached — mirrors Register semantics so the caller can splice it via the usual CE-body bare-reference path. See docs/draft/audio-clip-instance-cloning.md §3.

Fields

§start_beat: Option<f64>
§stop_beat: Option<f64>
§

InvokeComponentMethod

Fields

§component_type: String
§method: String
§args: Vec<Value>

Trait Implementations§

Source§

impl Clone for HostCallKind

Source§

fn clone(&self) -> HostCallKind

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HostCallKind

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more