SDL::IConv Struct Reference

An opaque handle representing string encoding conversion state. More...

Inheritance diagram for SDL::IConv:

Public Member Functions
	IConv (std::nullptr_t=nullptr) noexcept
	Default ctor.
constexpr	IConv (IConvRaw resource) noexcept
	Constructs from raw IConv.
constexpr	IConv (const IConv &other)=delete
	Copy constructor.
constexpr	IConv (IConv &&other) noexcept
	Move constructor.
constexpr	IConv (const IConvRef &other)=delete
constexpr	IConv (IConvRef &&other)=delete
	IConv (StringParam tocode, StringParam fromcode)
	This function allocates a context for the specified character set conversion.
	~IConv ()
	Destructor.
constexpr IConv &	operator= (IConv &&other) noexcept
	Assignment operator.
IConv &	operator= (const IConv &other)=delete
	Assignment operator.
	operator bool () const noexcept
	Converts to bool.
int	close ()
	This function frees a context used for character set conversion.
size_t	iconv (const char **inbuf, size_t *inbytesleft, char **outbuf, size_t *outbytesleft) const
	This function converts text between encodings, reading from and writing to a buffer.
constexpr	ResourceBase (RawPointer resource)
	Constructs from resource pointer.
constexpr	ResourceBase (std::nullptr_t=nullptr)
	Constructs null/invalid.
Public Member Functions inherited from SDL::ResourceBase< IConvRaw >
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< IConvRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.

Detailed Description

An opaque handle representing string encoding conversion state.

Since

This datatype is available since SDL 3.2.0.

Category:

Resource

See also

iconv_open

Constructor & Destructor Documentation

IConv()

SDL::IConv::IConv ( IConvRaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw IConv.

Parameters

resource

a IConvRaw 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_stdinc.h