Crate keeshond_datapack
source · [−]Expand description
keeshond_datapack lets you easily load resources for your game and cache them in memory,
mapped via pathname and accessible by handle objects. Define how they load
with the DataObject trait, by implementing a function that takes a Read + Seek object.
Define where they load from by instantiating a source::Source.
Datapack is used by Keeshond but can work with any engine.
How to use
- Implement the DataObject trait for each type of object you want to be able to load in.
- Instantiate a source::SourceManager object and give it a source::Source such as a source::FilesystemSource
- Create a folder for each package on disk (if using FilesystemSource).
- Create subfolders within each package for each data type and place files within.
- Instantiate a DataStore for each data type you want to load.
- (Optional) use DataStore::load_package() to ensure the package is loaded at start.
- When creating objects that need resources, instantiate a DataHandle with a desired path.
- Resolve this path using a DataStore to access the data. Store this handle somewhere it can be used later, as resolving does involve a couple hash lookups.
Pathnames are of the form path/to/file.png. They must match exactly, including the use of one
forward slash as a separator, and no separators at the beginning or end. The package name and
data type folders are not included (they are implied). Pathnames are also case-sensitive even on
platforms with case-insensitive filesystems (Windows, macOS).
Modules
The Source trait and implementations.
Structs
A path to a data resource, resolvable to a cached DataId.
A numeric ID used to refer to a DataObject of a specific type. Should only be used directly when performing operations that need an index into an array or Vec. This value may change between sessions. In most cases you probably want to use a DataHandle instead.
Storage that allows lookup and access of DataObjects of multiple types by wrapping multiple DataStores.
Storage that allows lookup and access of DataObjects of a given type
A token that indicates that a package is in use and should not be automatically unloaded.
An optional companion to a DataStore. If you have data that needs initialization with a backend (for example, textures you need to upload to a GPU), PreparedStore provides a way to handle this in a two-step process that is borrow-checker-friendly.
Enums
Return type when failing to load a DataObject from a DataStore
Return type when loading information from a DataStore
Behavior for when automatically loading a resource fails
Return type for when PreparedStore operations fail
Trust settings for a given DataObject resource type
Traits
Represents a data item loaded from a package. Implement this trait to allow the system to load new types of data.
Used with PreparedStore, this allows the definition of behavior when initializing resources with a backend. See PreparedStore for more information.
A boxable trait that implements both Read and Seek, used by the source::Source types.