Skip to main content

Assets

Struct Assets 

Source
pub struct Assets { /* private fields */ }

Implementations§

Source§

impl Assets

Source

pub fn new(root: impl AsRef<Path>) -> Result<Assets, Error>

Create with root as the asset directory. Path is canonicalized eagerly to make matching against notify events deterministic. On the web, root is a URL path relative to the page and is used as-is.

Source

pub fn set_web_preload<I, S>(&mut self, paths: I)
where I: IntoIterator<Item = S>, S: AsRef<str>,

Natively, in debug builds: check reads against paths instead of manifest.txt, for a game that sets AppConfig::web_preload. No-op in release builds and on the web.

Source

pub fn check_web_listed(&self, rel: impl AsRef<Path>)

Natively, in debug builds: warn (once per file) if rel isn’t in the web preload list, i.e. loading it would fail in the browser. Assets::read does this itself; call it when reading an asset some other way, e.g. by path. Does nothing when there is no list (no manifest.txt), for in-memory files, in release builds and on the web.

Source

pub fn root(&self) -> &Path

Source

pub fn resolve(&self, rel: impl AsRef<Path>) -> PathBuf

Source

pub fn read(&self, rel: impl AsRef<Path>) -> Result<Vec<u8>, Error>

Read an asset’s bytes: from memory if it was inserted or preloaded, otherwise from disk (native only).

Source

pub fn insert(&mut self, rel: impl AsRef<Path>, bytes: impl Into<Vec<u8>>)

Store bytes under rel, shadowing any file at that path.

Source

pub fn is_loaded(&self, rel: impl AsRef<Path>) -> bool

Whether rel is available in memory (inserted or preloaded).

Source

pub fn watch(&mut self) -> Result<(), Error>

Start watching the asset root recursively. Idempotent. On the web this logs that hot-reload is unavailable and returns Ok.

Source

pub fn drain_changes(&mut self) -> Vec<PathBuf>

Drain all queued filesystem changes since last call. Paths are canonicalized when possible. Idempotent across re-saves within one frame (HashSet-deduped). Always empty on the web.

Auto Trait Implementations§

§

impl !Freeze for Assets

§

impl !Sync for Assets

§

impl Forget for Assets

§

impl RefUnwindSafe for Assets

§

impl Send for Assets

§

impl Unpin for Assets

§

impl UnsafeUnpin for Assets

§

impl UnwindSafe for Assets

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

fn downcast(&self) -> &T

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

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

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

Source§

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

Source§

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

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