Crate utils

Source
Expand description

§DungeonRS utils

Modules§

async_ecs 🔒
This module handles asynchronous operations in ECS.
directories 🔒
Contains methods for working with directories that have special meanings to the software.
pathbuf 🔒
Various helper methods for working with Rust’s [PathBuf].
plugin 🔒
This module defines the CorePlugin.
version 🔒
Contains the functionality to calculate the current Cargo version and make it available to the rest of the application through a semver Version.

Structs§

AsyncComponent
Represents an ongoing asynchronous operation that will be polled for progress and/or completion.
CorePlugin
The CorePlugin registers systems for handling asynchronous components.
Receiver
The receiving side of a channel.
Sender
The sending side of a channel.

Enums§

DirectoryError
Contains the errors that can occur when attempting to retrieve one of the known directories.

Functions§

cache_path
Attempts to retrieve the current platform’s cache directory.
config_path
Attempts to retrieve the current platform’s configuration directory.
file_name
Retrieves the file name from the given [PathBuf].
report_progress
A helper function for reporting progress from a task controlled by AsyncComponent.
version
Returns the Version of the software as defined in the workspace.

Attribute Macros§

bevy_system
An attribute intended to annotate Bevy systems. It automatically annotates the system with several #[allow] lints common to Bevy systems for our linting configuration.