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
impl AssetSource
Sourcepub fn build() -> AssetSourceBuilder
pub fn build() -> AssetSourceBuilder
Starts building a new AssetSource
.
Sourcepub fn id(&self) -> AssetSourceId<'static>
pub fn id(&self) -> AssetSourceId<'static>
Returns this source’s id.
Sourcepub fn reader(&self) -> &dyn ErasedAssetReader
pub fn reader(&self) -> &dyn ErasedAssetReader
Return’s this source’s unprocessed AssetReader
.
Sourcepub fn writer(&self) -> Result<&dyn ErasedAssetWriter, MissingAssetWriterError>
pub fn writer(&self) -> Result<&dyn ErasedAssetWriter, MissingAssetWriterError>
Return’s this source’s unprocessed AssetWriter
, if it exists.
Sourcepub fn processed_reader(
&self,
) -> Result<&dyn ErasedAssetReader, MissingProcessedAssetReaderError>
pub fn processed_reader( &self, ) -> Result<&dyn ErasedAssetReader, MissingProcessedAssetReaderError>
Return’s this source’s processed AssetReader
, if it exists.
Sourcepub fn processed_writer(
&self,
) -> Result<&dyn ErasedAssetWriter, MissingProcessedAssetWriterError>
pub fn processed_writer( &self, ) -> Result<&dyn ErasedAssetWriter, MissingProcessedAssetWriterError>
Return’s this source’s processed AssetWriter
, if it exists.
Sourcepub fn event_receiver(&self) -> Option<&Receiver<AssetSourceEvent>>
pub fn event_receiver(&self) -> Option<&Receiver<AssetSourceEvent>>
Return’s this source’s unprocessed event receiver, if the source is currently watching for changes.
Sourcepub fn processed_event_receiver(&self) -> Option<&Receiver<AssetSourceEvent>>
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.
Sourcepub fn should_process(&self) -> bool
pub fn should_process(&self) -> bool
Returns true if the assets in this source should be processed.
Sourcepub fn get_default_reader(
_path: String,
) -> impl FnMut() -> Box<dyn ErasedAssetReader> + Send + Sync
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.
Sourcepub fn get_default_writer(
_path: String,
) -> impl FnMut(bool) -> Option<Box<dyn ErasedAssetWriter>> + Send + Sync
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.
Sourcepub fn get_default_watch_warning() -> &'static str
pub fn get_default_watch_warning() -> &'static str
Returns the default non-existent AssetWatcher
warning for the current platform.
Sourcepub fn get_default_watcher(
path: String,
file_debounce_wait_time: Duration,
) -> impl FnMut(Sender<AssetSourceEvent>) -> Option<Box<dyn AssetWatcher>> + Send + Sync
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.
Sourcepub fn gate_on_processor(&mut self, processor_data: Arc<AssetProcessorData>)
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§
impl Freeze for AssetSource
impl !RefUnwindSafe for AssetSource
impl Send for AssetSource
impl Sync for AssetSource
impl Unpin for AssetSource
impl !UnwindSafe for AssetSource
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.