nlib
nn::nlib::Utf32InputStream Class Reference

The class for reading UTF-32 string streams as UTF-8. More...

#include "nn/nlib/WcharInputStream.h"

+ Inheritance diagram for nn::nlib::Utf32InputStream:

Additional Inherited Members

- Public Member Functions inherited from nn::nlib::InputConverterStream
errno_t SetStream (InputStream *istr) noexcept
 Sets the input stream for reading the pre-converted data. More...
 
InputStreamGetStream () const noexcept
 Gets the input stream for reading the pre-converted data. More...
 
- Public Member Functions inherited from nn::nlib::InputStream
errno_t GetErrorValue () const noexcept
 Gets the error value. More...
 
size_t Pos () const noexcept
 Returns the current position in the stream. More...
 
uint64_t Pos64 () const noexcept
 Returns the current position in the stream as a 64-bit value. More...
 
bool IsEos () noexcept
 Returns true if the stream is finished being read through to the end. If the stream has not been read through to the end, or if an error occurs, the function returns false. More...
 
int Read () noexcept
 Reads one byte of data from the stream. More...
 
int Peek () noexcept
 Reads the next byte without consuming the stream. More...
 
size_t Skip (size_t nbytes) noexcept
 Skips over the number of bytes specified by nbytes. More...
 
size_t Read (void *ptr, size_t nbytes) noexcept
 Reads the number of bytes of data specified by nbytes into the memory region specified by ptr. More...
 
bool Close () noexcept
 Closes the stream. Returns true if successful. More...
 
 operator bool () const
 Returns true if no internal error has occurred.
 
constexpr InputStream () noexcept
 Instantiates the object. This function is called from the derived class.
 
virtual ~InputStream () noexcept
 Destructor. This function is called from the derived class.
 
- Protected Member Functions inherited from nn::nlib::InputStream
void ResetBuffer (void *p, size_t nbytes) noexcept
 Sets the buffer held by InputStream. More...
 
void SetError (errno_t e) const noexcept
 Sets an error to InputStream. More...
 

Detailed Description

The class for reading UTF-32 string streams as UTF-8.

Description
The InputConverterStream::SetStream function sets a stream for reading UTF-32 strings, and this stream is used. The endianness of the UTF-32 must match the endianness of the executing machine.
The following shows an example of code for a process that initializes the object.
InputStream* istr = ....;
Utf32InputStream is;
if (nlib_is_error(is.Init())) { ERROR; }
if (nlib_is_error(is.SetStream(istr))) { ERROR; }
The transition of the object state.
The overview of the object state transitions is described below:
dot_inline_dotgraph_11.png

Definition at line 33 of file WcharInputStream.h.


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