bevy_asset::io

Struct AssetSource

Source
pub struct AssetSource { /* private fields */ }
Expand description

A collection of unprocessed and processed AssetReader, AssetWriter, and AssetWatcher instances for a specific asset source, identified by an AssetSourceId.

Implementations§

Source§

impl AssetSource

Source

pub fn build() -> AssetSourceBuilder

Starts building a new AssetSource.

Source

pub fn id(&self) -> AssetSourceId<'static>

Returns this source’s id.

Source

pub fn reader(&self) -> &dyn ErasedAssetReader

Return’s this source’s unprocessed AssetReader.

Source

pub fn writer(&self) -> Result<&dyn ErasedAssetWriter, MissingAssetWriterError>

Return’s this source’s unprocessed AssetWriter, if it exists.

Source

pub fn processed_reader( &self, ) -> Result<&dyn ErasedAssetReader, MissingProcessedAssetReaderError>

Return’s this source’s processed AssetReader, if it exists.

Source

pub fn processed_writer( &self, ) -> Result<&dyn ErasedAssetWriter, MissingProcessedAssetWriterError>

Return’s this source’s processed AssetWriter, if it exists.

Source

pub fn event_receiver(&self) -> Option<&Receiver<AssetSourceEvent>>

Return’s this source’s unprocessed event receiver, if the source is currently watching for changes.

Source

pub fn processed_event_receiver(&self) -> Option<&Receiver<AssetSourceEvent>>

Return’s this source’s processed event receiver, if the source is currently watching for changes.

Source

pub fn should_process(&self) -> bool

Returns true if the assets in this source should be processed.

Source

pub fn get_default_reader( _path: String, ) -> impl FnMut() -> Box<dyn ErasedAssetReader> + Send + Sync

Returns a builder function for this platform’s default AssetReader. path is the relative path to the asset root.

Source

pub fn get_default_writer( _path: String, ) -> impl FnMut(bool) -> Option<Box<dyn ErasedAssetWriter>> + Send + Sync

Returns a builder function for this platform’s default AssetWriter. path is the relative path to the asset root. This will return None if this platform does not support writing assets by default.

Source

pub fn get_default_watch_warning() -> &'static str

Returns the default non-existent AssetWatcher warning for the current platform.

Source

pub fn get_default_watcher( path: String, file_debounce_wait_time: Duration, ) -> impl FnMut(Sender<AssetSourceEvent>) -> Option<Box<dyn AssetWatcher>> + Send + Sync

Returns a builder function for this platform’s default AssetWatcher. path is the relative path to the asset root. This will return None if this platform does not support watching assets by default. file_debounce_time is the amount of time to wait (and debounce duplicate events) before returning an event. Higher durations reduce duplicates but increase the amount of time before a change event is processed. If the duration is set too low, some systems might surface events before their filesystem has the changes.

Source

pub fn gate_on_processor(&mut self, processor_data: Arc<AssetProcessorData>)

This will cause processed AssetReader futures (such as AssetReader::read) to wait until the AssetProcessor has finished processing the requested asset.

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> 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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<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<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
Source§

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

Source§

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