Skip to main content

InklLoader

Struct InklLoader

pub struct InklLoader;

Expand description

Asset loader for .inkl (compiled locale overlay) files. Decodes via brink_format::read_inkl into a LocaleAsset.

Trait Implementations§

impl AssetLoader for InklLoader

type Asset = LocaleAsset

The top level Asset loaded by this AssetLoader.

type Settings = ()

The settings type used by this AssetLoader.

type Error = InklLoaderError

The type of error which could be encountered by this loader.

async fn load( &self, reader: &mut dyn Reader, _settings: &Self::Settings, _load_context: &mut LoadContext<'_>, ) -> Result<Self::Asset, Self::Error>

Asynchronously loads AssetLoader::Asset (and any other labeled assets) from the bytes provided by Reader.

fn extensions(&self) -> &[&str]

Returns a list of extensions supported by this AssetLoader, without the preceding dot. Note that users of this AssetLoader may choose to load files with a non-matching extension.

impl Default for InklLoader

fn default() -> InklLoader

Returns the “default value” for a type. Read more

impl TypePath for InklLoader

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type. Read more

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type. Read more

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous. Read more

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous. Read more

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous. Read more

Auto Trait Implementations§

impl Freeze for InklLoader

impl RefUnwindSafe for InklLoader

impl Send for InklLoader

impl Sync for InklLoader

impl Unpin for InklLoader

impl UnsafeUnpin for InklLoader

impl UnwindSafe for InklLoader

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> ConditionalSend for T
where T: Send,

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

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

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.

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

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

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

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

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

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

impl<T> DowncastSend for T
where T: Any + Send,

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

impl<T> DynamicTypePath for T
where T: TypePath,

fn reflect_type_path(&self) -> &str

See TypePath::type_path.

fn reflect_short_type_path(&self) -> &str

See TypePath::short_type_path.

fn reflect_type_ident(&self) -> Option<&str>

See TypePath::type_ident.

fn reflect_crate_name(&self) -> Option<&str>

See TypePath::crate_name.

fn reflect_module_path(&self) -> Option<&str>

See TypePath::module_path.

impl<L> ErasedAssetLoader for L
where L: AssetLoader + Send + Sync,

fn load<'a>( &'a self, reader: &'a mut dyn Reader, settings: &'a (dyn Settings + 'static), load_context: LoadContext<'a>, ) -> Pin<Box<dyn ConditionalSendFuture<Output = Result<ErasedLoadedAsset, BevyError>> + 'a>>

Processes the asset in an asynchronous closure.

fn extensions(&self) -> &[&str]

Returns a list of extensions supported by this asset loader, without the preceding dot.

fn deserialize_meta( &self, meta: &[u8], ) -> Result<Box<dyn AssetMetaDyn>, DeserializeMetaError>

Deserializes metadata from the input meta bytes into the appropriate type (erased as Box<dyn AssetMetaDyn>).

fn default_meta(&self) -> Box<dyn AssetMetaDyn>

Returns the default meta value for the AssetLoader (erased as Box<dyn AssetMetaDyn>).

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

Returns the type path of the AssetLoader.

fn type_id(&self) -> TypeId

Returns the TypeId of the AssetLoader.

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

Returns the type name of the top-level Asset loaded by the AssetLoader.

fn asset_type_id(&self) -> TypeId

Returns the TypeId of the top-level Asset loaded by the AssetLoader.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromWorld for T
where T: Default,

fn from_world(_world: &mut World) -> T

Creates Self using default().

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

const WITNESS: W = W::MAKE

A constant of the type witness

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

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoResult<T> for T

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.

impl<A> Is for A
where A: Any,

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more

impl<T> Lookup<T> for T

fn into_owned(self) -> T

impl<T> Settings for T
where T: 'static + Send + Sync,

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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