Struct dx::foundation::resource::Store

source · [−]

pub struct Store<C, K> { /* private fields */ }

Expand description

Resource store. Responsible for holding and presenting resources.

Implementations

impl<C, K> Store<C, K> where
K: Key,

pub fn new(opt: StoreOpt<C, K>) -> Result<Store<C, K>, StoreError<K>>

Create a new store.

Failures

This function will fail if the root path in the StoreOpt doesn’t resolve to a correct canonicalized path.

pub fn sync(&mut self, ctx: &mut C) where
K: for<'a> From<&'a Path>,

Synchronize the Store by updating the resources that ought to with a provided context.

Methods from Deref<Target = Storage<C, K>>

pub fn root(&self) -> &Path

The canonicalized root the Storage is configured with.

pub fn get<T>(
    &mut self,
    key: &K,
    ctx: &mut C
) -> Result<Res<T>, StoreErrorOr<T, C, K, ()>> where
    T: Load<C, K, ()>,

Get a resource from the Storage and return an error if its loading failed.

This function uses the default loading method.

pub fn get_by<T, M>(
    &mut self,
    key: &K,
    ctx: &mut C,
    M
) -> Result<Res<T>, StoreErrorOr<T, C, K, M>> where
    T: Load<C, K, M>,

Get a resource from the Storage by using a specific method and return and error if its loading failed.

pub fn get_proxied<T, P>(
    &mut self,
    key: &K,
    proxy: P,
    ctx: &mut C
) -> Result<Res<T>, StoreError<K>> where
    T: Load<C, K, ()>,
    P: FnOnce() -> T,

Get a resource from the Storage for the given key. If it fails, a proxied version is used, which will get replaced by the resource once it’s available and reloaded.

This function uses the default loading method.

pub fn get_proxied_by<T, M, P>(
    &mut self,
    key: &K,
    proxy: P,
    ctx: &mut C,
    method: M
) -> Result<Res<T>, StoreError<K>> where
    T: Load<C, K, M>,
    P: FnOnce() -> T,

Get a resource from the Storage for the given key by using a specific method. If it fails, a proxied version is used, which will get replaced by the resource once it’s available and reloaded.

Trait Implementations

impl<C, K> Deref for Store<C, K>

type Target = Storage<C, K>

The resulting type after dereferencing.

fn deref(&self) -> &<Store<C, K> as Deref>::Target

Dereferences the value.

impl<C, K> DerefMut for Store<C, K>

fn deref_mut(&mut self) -> &mut <Store<C, K> as Deref>::Target

Mutably dereferences the value.

Auto Trait Implementations

impl<C, K> !RefUnwindSafe for Store<C, K>

impl<C, K> !Send for Store<C, K>

impl<C, K> !Sync for Store<C, K>

impl<C, K> Unpin for Store<C, K> where
K: Unpin,

impl<C, K> !UnwindSafe for Store<C, K>

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · 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> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<Target, From> Getter<From> for Target where
From: AsRef<Target>,

fn get(from: &From) -> &Target

Typed getter

impl<'a, T, C, M> Inspect<'a, C, &'a C, M> for T

fn inspect(ctx: &'a mut C) -> &'a C

Inspect the context.

impl<'a, T, C, M> Inspect<'a, C, &'a mut C, M> for T

fn inspect(ctx: &'a mut C) -> &'a mut C

Inspect the context.

impl<'a, T, C, M> Inspect<'a, C, (), M> for T

fn inspect(&'a mut C)

Inspect the context.

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

const: unstable · 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<Fr, To> IntoColor<To> for Fr where
To: FromColor<Fr>,

fn into_color(self) -> To

Convert into color

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

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

impl<T> SetParameter for T

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,

Sets value as a parameter of self.

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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.

const: unstable · 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