Struct EngineApi 

pub struct EngineApi { /* private fields */ }

The loaded, indexed Godot engine model.

Holds the deserialized ApiData plus the name → id indices rebuilt at load (kept out of the blob so the archived form stays portable — Playbook §4.5) and the hand-authored GDScript layer (pseudo-constants + builtin functions).

Implementations

impl EngineApi

pub fn classes(&self) -> &[ClassData]

All engine classes (extension_api.json order).

pub fn builtins(&self) -> &[BuiltinData]

All builtin Variant types.

pub fn class(&self, id: ClassId) -> &ClassData

The class with the given id.

pub fn builtin(&self, id: BuiltinId) -> &BuiltinData

The builtin type with the given id.

pub fn class_by_name(&self, name: &str) -> Option<ClassId>

Resolve an engine class name to its id.

pub fn builtin_by_name(&self, name: &str) -> Option<BuiltinId>

Resolve a builtin type name to its id.

pub fn int_builtin(&self) -> Option<BuiltinId>

The cached id of the int builtin.

pub fn singleton(&self, name: &str) -> Option<ClassId>

Resolve a singleton symbol (Input, OS, …) to the class it is an instance of.

pub fn utility(&self, name: &str) -> Option<&UtilityFn>

Look up a @GlobalScope utility function (sin, print, …).

pub fn global_enum(&self, name: &str) -> Option<&EnumInfo>

Look up a global (@GlobalScope) enum (Error, Key, …).

pub fn global_const(&self, name: &str) -> Option<&GlobalConst>

Look up a hand-authored pseudo-constant (PI/TAU/INF/NAN).

pub fn gdscript_builtin(&self, name: &str) -> Option<&BuiltinFn>

Look up a hand-authored GDScript builtin function (preload/range/len/…).

pub fn lookup_member(&self, class: ClassId, name: &str) -> Option<MemberRef<'_>>

Resolve name on class, walking the base chain; the nearest declarer wins.

pub fn is_subclass(&self, sub: ClassId, sup: ClassId) -> bool

Whether sub is sup or transitively inherits it.

pub fn members_of(&self, class: ClassId) -> Vec<MemberRef<'_>>

Every member visible on class including inherited ones, deduped with the nearest declarer winning — the candidate set for recv.<TAB> completion (Playbook §4.3).

pub fn builtin_member( &self, builtin: BuiltinId, name: &str, ) -> Option<&BuiltinMember>

A field of a builtin type (Vector2.x).

pub fn builtin_method( &self, builtin: BuiltinId, name: &str, ) -> Option<&MethodSig>

A method of a builtin type (Array.size).

pub fn builtin_operators(&self, builtin: BuiltinId) -> &[OperatorSig]

The operator overloads of a builtin type (the caller matches op + RHS).

impl EngineApi

pub fn from_data(data: ApiData) -> Self

Build the indexed model from a freshly decoded ApiData, rebuilding the name indices and merging the hand-authored GDScript layer.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, LoadError>

Decode and index an engine-API blob produced by xtask codegen-api.

The bytes are copied into a 16-byte-aligned buffer before validation so a misaligned source (e.g. include_bytes! or a fetch()ed ArrayBuffer) decodes correctly.

Errors

Returns LoadError::Decode if the blob fails rkyv validation.

pub fn version(&self) -> &ApiVersion

The Godot version this model was generated from.

Trait Implementations

impl Debug for EngineApi

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

Formats the value using the given formatter.