Handle to an owned storage. More...
Inheritance diagram for SDL::Storage:
Public Member Functions | |
| constexpr | Storage (SDL_Storage *resource={}) |
| Constructs from the underlying resource. | |
| constexpr | Storage (const Storage &other)=delete |
| constexpr | Storage (Storage &&other)=default |
| Move constructor. | |
| ~Storage () | |
| Frees up resource when object goes out of scope. | |
| Storage & | operator= (Storage other) |
| Assignment operator. | |
| constexpr | StorageRef (const StorageRef &other) |
| Copy constructor. | |
| constexpr | StorageRef (StorageRef &&other) |
| Move constructor. | |
 Public Member Functions inherited from SDL::StorageRef | |
| constexpr | StorageRef (const StorageRef &other) |
| Copy constructor. | |
| constexpr | StorageRef (StorageRef &&other) |
| Move constructor. | |
| constexpr | ~StorageRef ()=default |
| Default constructor. | |
| StorageRef & | operator= (StorageRef other) |
| Assignment operator. | |
| bool | reset (SDL_Storage *newResource={}) |
| Closes and frees a storage container. | |
| bool | Close () |
| Closes and frees a storage container. | |
| StorageBase (StringParam override, PropertiesBase &props) | |
| Opens up a read-only container for the application's filesystem. | |
| StorageBase (StringParam org, StringParam app, PropertiesBase &props) | |
| Opens up a container for a user's unique read/write filesystem. | |
| StorageBase (StringParam path) | |
| Opens up a container for local filesystem storage. | |
| StorageBase (const StorageInterface &iface, void *userdata) | |
| Opens up a container using a client-provided storage interface. | |
| Public Member Functions inherited from SDL::StorageBase | |
| StorageBase (StringParam override, PropertiesBase &props) | |
| Opens up a read-only container for the application's filesystem. | |
| StorageBase (StringParam org, StringParam app, PropertiesBase &props) | |
| Opens up a container for a user's unique read/write filesystem. | |
| StorageBase (StringParam path) | |
| Opens up a container for local filesystem storage. | |
| StorageBase (const StorageInterface &iface, void *userdata) | |
| Opens up a container using a client-provided storage interface. | |
| bool | Ready () const |
| Checks if the storage container is ready to use. | |
| std::optional< Uint64 > | GetFileSize (StringParam path) const |
| Query the size of a file within a storage container. | |
| std::string | ReadFile (StringParam path) const |
| Synchronously read a file from a storage container into a client-provided buffer. | |
| bool | ReadFile (StringParam path, TargetBytes destination) const |
| Synchronously read a file from a storage container into a client-provided buffer. | |
| template<class T > | |
| std::vector< T > | ReadFileAs (StringParam path) const |
| Synchronously read a file from a storage container into a client-provided buffer. | |
| void | WriteFile (StringParam path, SourceBytes source) |
| Synchronously write a file from client memory into a storage container. | |
| void | CreateDirectory (StringParam path) |
| Create a directory in a writable storage container. | |
| std::vector< Path > | EnumerateDirectory (StringParam path) |
| Enumerate a directory. | |
| void | EnumerateDirectory (StringParam path, EnumerateDirectoryCB callback) |
| Enumerate a directory in a storage container through a callback function. | |
| void | EnumerateDirectory (StringParam path, EnumerateDirectoryCallback callback, void *userdata) |
| Enumerate a directory in a storage container through a callback function. | |
| void | RemovePath (StringParam path) |
| Remove a file or an empty directory in a writable storage container. | |
| void | RenamePath (StringParam oldpath, StringParam newpath) |
| Rename a file or directory in a writable storage container. | |
| void | CopyFile (StringParam oldpath, StringParam newpath) |
| Copy a file in a writable storage container. | |
| PathInfo | GetPathInfo (StringParam path) const |
| Get information about a filesystem path in a storage container. | |
| Uint64 | GetSpaceRemaining () const |
| Queries the remaining space in a storage container. | |
| OwnArray< char * > | GlobDirectory (StringParam path, StringParam pattern, GlobFlags flags) |
| Enumerate a directory tree, filtered by pattern, and return a list. | |
| constexpr | Resource (T resource={}) |
| Constructs the underlying resource. | |
| constexpr | Resource (std::nullptr_t) |
| Equivalent to default ctor. | |
| constexpr | Resource (std::nullopt_t) |
| Equivalent to default ctor. | |
| Resource (const Resource &other)=delete | |
| Resource (Resource &&other)=delete | |
| Public Member Functions inherited from SDL::Resource< SDL_Storage * > | |
| constexpr | Resource (SDL_Storage * resource={}) |
| Constructs the underlying resource. | |
| constexpr | Resource (std::nullptr_t) |
| Equivalent to default ctor. | |
| constexpr | Resource (std::nullopt_t) |
| Equivalent to default ctor. | |
| Resource (const Resource &other)=delete | |
| Resource (Resource &&other)=delete | |
| Resource & | operator= (const Resource &other)=delete |
| Resource & | operator= (Resource &&other)=delete |
| constexpr | operator bool () const |
| True if contains a valid resource. | |
| constexpr bool | operator== (const Resource &other) const=default |
| Comparison. | |
| constexpr bool | operator== (std::nullopt_t) const |
| Comparison. | |
| constexpr bool | operator== (std::nullptr_t) const |
| Comparison. | |
| constexpr SDL_Storage * | get () const |
| Return contained resource;. | |
| constexpr SDL_Storage * | release (SDL_Storage * newResource={}) |
| Return contained resource and empties or replace value. | |
| constexpr const SDL_Storage * | operator-> () const |
| Access to fields. | |
| constexpr SDL_Storage * | operator-> () |
| Access to fields. | |
Detailed Description
- Category:
- Resource
- See also
- StorageBase
- StorageRef
The documentation for this struct was generated from the following file:
- SDL3pp/SDL3pp_storage.h
