Struct bevy::asset::io::AssetSource

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§

§

impl AssetSource

pub fn build() -> AssetSourceBuilder

Starts building a new AssetSource.

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

Returns this source’s id.

pub fn reader(&self) -> &(dyn AssetReader + 'static)

Return’s this source’s unprocessed AssetReader.

pub fn writer( &self ) -> Result<&(dyn AssetWriter + 'static), MissingAssetWriterError>

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

pub fn processed_reader( &self ) -> Result<&(dyn AssetReader + 'static), MissingProcessedAssetReaderError>

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

pub fn processed_writer( &self ) -> Result<&(dyn AssetWriter + 'static), MissingProcessedAssetWriterError>

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

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

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

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.

pub fn should_process(&self) -> bool

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

pub fn get_default_reader(_path: String) -> impl FnMut() + Send + Sync

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

pub fn get_default_writer(_path: String) -> impl FnMut(bool) + 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.

pub fn get_default_watch_warning() -> &'static str

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

pub fn get_default_watcher( path: String, file_debounce_wait_time: Duration ) -> impl FnMut(Sender<AssetSourceEvent>) + 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.

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
§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

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

§

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

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

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

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

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

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.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

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
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.

§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

source§

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

§

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>,

§

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

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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
§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

§

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

§

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

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,