Struct Resource

pub struct Resource<B>(/* private fields */)
where
    B: 'static + ToOwned + ?Sized;

A resource (string or binary) loaded in memory.

In debug mode, this structure contains the data, the path to the file, and a timestamp in order to support the reload_if_changed method.

In release mode, it contains only an immutable, static reference to the data.

This struct implements Deref and AsRef (for the &str and &[u8] types respectively) which allows you to refer transparently to the data.

Alternatively, it also implements Into<Cow<'static, T>>. In debug mode, this will return a Cow that owns the data. In release mode, it returns a Cow that borrows the static data.

Implementations

impl<B> Resource<B>

where B: 'static + ToOwned + ?Sized, B::Owned: ReadFromFile,

pub fn changed(&self) -> bool

Returns true if the resource has changed since loading.

In release mode, always returns false.

pub fn reload(&mut self)

Reloads the resource.

In release mode, does nothing.

pub fn reload_if_changed(&mut self) -> bool

Reloads the resource only if it has changed since the previous load. Returns true if the resource was reloaded.

In release mode, does nothing.

Trait Implementations

impl<B> AsRef<B> for Resource<B>

where B: 'static + ToOwned + ?Sized, B::Owned: AsRef<B>,

fn as_ref(&self) -> &B

Converts this type into a shared reference of the (usually inferred) input type.

impl<B> Clone for Resource<B>

where B: 'static + ToOwned + ?Sized, B::Owned: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B> Deref for Resource<B>

where B: 'static + ToOwned + ?Sized, B::Owned: AsRef<B>,

type Target = B

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<B> Into<Cow<'static, B>> for Resource<B>

where B: 'static + ToOwned + ?Sized,

fn into(self) -> Cow<'static, B>

Converts this type into the (usually inferred) input type.