Enum fyrox::asset::state::ResourceState

pub enum ResourceState {
    Pending {
        wakers: WakersList,
    },
    LoadError {
        error: LoadError,
    },
    Ok(Box<dyn ResourceData>),
}

Resource could be in three possible states:

1. Pending - it is loading.
2. LoadError - an error has occurred during the load.
3. Ok - resource is fully loaded and ready to use.

Why it is so complex? Short answer: asynchronous loading. Long answer: when you loading a scene you expect it to be loaded as fast as possible, use all available power of the CPU. To achieve that each resource ideally should be loaded on separate core of the CPU, but since this is asynchronous, we must have the ability to track the state of the resource.

Variants

Pending

Resource is loading from external resource or in the queue to load.

Fields

wakers: WakersList

List of wakers to wake future when resource is fully loaded.

LoadError

An error has occurred during the load.

Fields

error: LoadError

An error. This wrapped in Option only to be Default_ed.

Ok(Box<dyn ResourceData>)

Actual resource data when it is fully loaded.

Implementations

impl ResourceState

pub const PENDING_WAKERS: &'static str = "Pending@wakers"

pub const LOAD_ERROR_ERROR: &'static str = "LoadError@error"

pub const OK_F_0: &'static str = "Ok@0"

impl ResourceState

pub fn new_pending() -> ResourceState

Creates new resource in pending state.

pub fn new_load_error(error: LoadError) -> ResourceState

Creates new resource in error state.

pub fn new_ok<T>(data: T) -> ResourceState

where T: ResourceData,

Creates new resource in ok (resource with data) state.

pub fn is_loading(&self) -> bool

Checks whether the resource is still loading or not.

pub fn switch_to_pending_state(&mut self)

Switches the internal state of the resource to ResourceState::Pending.

pub fn commit(&mut self, state: ResourceState)

Changes ResourceState::Pending state to ResourceState::Ok(data) with given data. Additionally it wakes all futures.

pub fn commit_ok<T>(&mut self, data: T)

where T: ResourceData,

Changes internal state to ResourceState::Ok

pub fn commit_error<E>(&mut self, error: E)

where E: ResourceLoadError,

Changes internal state to ResourceState::LoadError.

Trait Implementations

impl Debug for ResourceState

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

Formats the value using the given formatter.

impl Default for ResourceState

fn default() -> ResourceState

Returns the “default value” for a type.

impl Drop for ResourceState

fn drop(&mut self)

Executes the destructor for this type.

impl Reflect for ResourceState

where ResourceState: 'static, WakersList: Reflect, LoadError: Reflect, Box<dyn ResourceData>: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

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

fn set( &mut self, value: Box<dyn Reflect> ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn as_any(&self, func: &mut dyn FnMut(&(dyn Any + 'static)))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Any + 'static)))

fn as_reflect(&self, func: &mut dyn FnMut(&(dyn Reflect + 'static)))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Reflect + 'static)))

fn fields(&self, func: &mut dyn FnMut(&[&(dyn Reflect + 'static)]))

fn fields_mut( &mut self, func: &mut dyn FnMut(&mut [&mut (dyn Reflect + 'static)]) )

fn field( &self, name: &str, func: &mut dyn FnMut(Option<&(dyn Reflect + 'static)>) )

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut (dyn Reflect + 'static)>) )

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>) )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>) )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>) )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>) )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>) )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>) )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>) )

impl Visit for ResourceState

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

Read or write this value, depending on whether Visitor::is_reading() is true or false.