Struct yy_boss::YyResourceHandler

pub struct YyResourceHandler<T: YyResource> { /* fields omitted */ }

Implementations

impl<T: YyResource> YyResourceHandler<T>

pub fn get(&self, name: &str) -> Option<&YyResourceData<T>>

Returns an immutable reference to a resource's data, if it exists.

Since associated data is lazily loaded, and be unloaded at any time, there may not be any associated data returned. You can request that data to be loaded using load_resource_associated_data.

pub unsafe fn get_mut(&mut self, name: &str) -> Option<&mut YyResourceData<T>>

Returns an mutable reference to a resource's data, if it exists.

Since associated data is lazily loaded, and be unloaded at any time, there may not be any associated data returned. You can request that data to be loaded using load_resource_associated_data.

Safety

This function is VERY UNSAFE, but not in a memory sense. The entire purpose of this library is, in effect, to shield the user from making changes to the Yyp database which require side effects. How could a user know which effects to use and what to not use? They absolutely cannot. Unless you are very certain that the change you are making will not impact anything outside that file, do not use this function.

Additionally, be aware that mutating data does not guarentee serialization: please use force_serialize.

pub fn force_serialize(
    &mut self,
    name: &str
) -> Result<(), YyResourceHandlerError>

Attempts to mark a resource for serialization, and returns if it was succesfully marked.

pub fn load_resource_associated_data(
    &mut self,
    resource_name: &str,
    root: &Path,
    tcu: &TrailingCommaUtility
) -> Result<&T::AssociatedData, YyResourceHandlerError>

Loads in the associated data of a given resource name, if that resource exists and is managed.

If that resource already has some associated data, it will be discarded, and the new data will be loaded. If the resource does not exist or is not of the type that this manager handles, an error will be returned.

pub fn unload_resource_associated_data(
    &mut self,
    resource_name: &str
) -> Result<(), YyResourceHandlerError>

Unloads a resource. This will free up some memory.

If the resource does not exist on this handler, an error will be returned.

impl YyResourceHandler<Object>

pub fn add_event(&mut self, identifier: &str, event_type: EventType) -> bool

pub fn remove_event(&mut self, identifier: &str, event_type: EventType) -> bool

Trait Implementations

impl<T: Debug + YyResource> Debug for YyResourceHandler<T>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: YyResource> Default for YyResourceHandler<T>

pub fn default() -> Self

Returns the "default value" for a type.

impl<'a, T: YyResource> IntoIterator for &'a YyResourceHandler<T>

type Item = &'a YyResourceData<T>

The type of the elements being iterated over.

type IntoIter = Values<'a, String, YyResourceData<T>>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq + YyResource> PartialEq<YyResourceHandler<T>> for YyResourceHandler<T>

pub fn eq(&self, other: &YyResourceHandler<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &YyResourceHandler<T>) -> bool

This method tests for !=.

impl<T: YyResource> StructuralPartialEq for YyResourceHandler<T>