Struct gdnative_bindings_lily::ResourceInteractiveLoader

pub struct ResourceInteractiveLoader { /* fields omitted */ }

core class ResourceInteractiveLoader inherits Reference (reference counted).

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

ResourceInteractiveLoader inherits methods from:

• Reference
• Object

Safety

All types in the Godot API have “interior mutability” in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl ResourceInteractiveLoader

pub fn get_resource(&self) -> Option<Ref<Resource, Shared>>

Returns the loaded resource if the load operation completed successfully, null otherwise.

pub fn get_stage(&self) -> i64

Returns the load stage. The total amount of stages can be queried with [method get_stage_count].

pub fn get_stage_count(&self) -> i64

Returns the total amount of stages (calls to [method poll]) needed to completely load this resource.

pub fn poll(&self) -> GodotResult

Polls the loading operation, i.e. loads a data chunk up to the next stage. Returns [constant OK] if the poll is successful but the load operation has not finished yet (intermediate stage). This means [method poll] will have to be called again until the last stage is completed. Returns [constant ERR_FILE_EOF] if the load operation has completed successfully. The loaded resource can be obtained by calling [method get_resource]. Returns another [enum Error] code if the poll has failed.

pub fn wait(&self) -> GodotResult

Polls the loading operation successively until the resource is completely loaded or a [method poll] fails. Returns [constant ERR_FILE_EOF] if the load operation has completed successfully. The loaded resource can be obtained by calling [method get_resource]. Returns another [enum Error] code if a poll has failed, aborting the operation.

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing. Returns whether the initialization was successful.

Trait Implementations

impl Debug for ResourceInteractiveLoader

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

Formats the value using the given formatter.

impl Deref for ResourceInteractiveLoader

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for ResourceInteractiveLoader

fn deref_mut(&mut self) -> &mut Reference

Mutably dereferences the value.

impl GodotObject for ResourceInteractiveLoader

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Sealed for ResourceInteractiveLoader

impl SubClass<Object> for ResourceInteractiveLoader

impl SubClass<Reference> for ResourceInteractiveLoader