SDL::AsyncIO Struct Reference

The asynchronous I/O operation structure. More...

Inheritance diagram for SDL::AsyncIO:

Public Member Functions
constexpr	AsyncIO (AsyncIORaw resource) noexcept
	Constructs from raw AsyncIO.
constexpr	AsyncIO (const AsyncIO &other)=delete
	Copy constructor.
constexpr	AsyncIO (AsyncIO &&other) noexcept
	Move constructor.
constexpr	AsyncIO (const AsyncIORef &other)=delete
constexpr	AsyncIO (AsyncIORef &&other)=delete
	AsyncIO (StringParam file, StringParam mode)
	Use this function to create a new AsyncIO object for reading from and/or writing to a named file.
	~AsyncIO ()
	Destructor.
constexpr AsyncIO &	operator= (AsyncIO &&other) noexcept
	Assignment operator.
AsyncIO &	operator= (const AsyncIO &other)=delete
	Assignment operator.
bool	Close (bool flush, AsyncIOQueueRef queue, void *userdata)
	Close and free any allocated resources for an async I/O object.
Sint64	GetSize ()
	Use this function to get the size of the data stream in an AsyncIO.
void	Read (void *ptr, Uint64 offset, Uint64 size, AsyncIOQueueRef queue, void *userdata)
	Start an async read.
void	Write (void *ptr, Uint64 offset, Uint64 size, AsyncIOQueueRef queue, void *userdata)
	Start an async write.
constexpr	ResourceBase (RawPointer resource)
	Constructs from resource pointer.
constexpr	ResourceBase (std::nullptr_t=nullptr)
	Constructs null/invalid.
Public Member Functions inherited from SDL::ResourceBase< AsyncIORaw >
constexpr	ResourceBase (RawPointer resource)
	Constructs from resource pointer.
constexpr	operator bool () const
	Converts to bool.
constexpr auto	operator<=> (const ResourceBase &other) const=default
	Comparison.
constexpr RawConstPointer	operator-> () const noexcept
	member access to underlying resource pointer.
constexpr RawPointer	get () const noexcept
	Retrieves underlying resource pointer.
constexpr RawPointer	release () noexcept
	Retrieves underlying resource pointer and clear this.

Additional Inherited Members
Public Types inherited from SDL::ResourceBase< AsyncIORaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.

Detailed Description

The asynchronous I/O operation structure.

This operates as an opaque handle. One can then request read or write operations on it.

Since

This struct is available since SDL 3.2.0.

See also

AsyncIOFromFile

Category:

Resource

Constructor & Destructor Documentation

AsyncIO()

SDL::AsyncIO::AsyncIO ( AsyncIORaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw AsyncIO.

Parameters

resource

a AsyncIORaw to be wrapped.

This assumes the ownership, call release() if you need to take back.

---

The documentation for this struct was generated from the following file:

• SDL3pp/SDL3pp_asyncio.h