nlib
|
The base class for classes that act internally like InputStream
to convert data.
More...
#include "nn/nlib/InputConverterStream.h"
Public Member Functions | |
errno_t | SetStream (InputStream *istr) noexcept |
Sets the input stream for reading the pre-converted data. More... | |
InputStream * | GetStream () const noexcept |
Gets the input stream for reading the pre-converted data. More... | |
![]() | |
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... | |
template<size_t N> | |
size_t | Read (nlib_byte_t(&buf)[N]) noexcept |
A template overload of the above function. | |
bool | Close () noexcept |
Closes the stream. Returns true if successful. More... | |
bool | Mark (size_t readlimit) noexcept |
This function provides settings that allow you to return to the current load position using GoBackToMark() . More... | |
bool | GoBackToMark () noexcept |
This function allows you to return to the load position that the last Mark() has been executed at. More... | |
bool | IsMarkSupported () const noexcept |
This function returns true if this stream supports Mark() and GoBackToMark() . | |
operator bool () const | |
Returns true if the object has been initialized and an error has not occurred inside, or returns false if an error has occurred inside. | |
constexpr | InputStream () noexcept |
Instantiates the object with default parameters (default constructor). This function is called from the derived class. | |
virtual | ~InputStream () noexcept |
Destructor. This function is called from the derived class. | |
Additional Inherited Members | |
![]() | |
void | SetBuffer (void *p, size_t nbytes, bool is_mark_supported, bool is_buf_readonly) noexcept |
Sets the buffer held by InputStream . More... | |
void | SetError (errno_t e) const noexcept |
Sets an error to InputStream . More... | |
The base class for classes that act internally like InputStream
to convert data.
SetStream
function to set an input stream and read the data, the data conversion result can be read using the InputStream
interface. Users normally do not make direct use of this feature. InputTransform::GetWorkBuffer()
function registers a buffer that InputStream
will use. InputStream
retrieves data from this buffer and provides it to the user. The InputTransform::Transform()
function reads data from InputStream
and writes that data in the converted format. The InputTransform::OnSetStream()
function writes a process to be performed when InputConverterStream::SetStream()
is called. The InputTransform::OnClose()
function is called when a stream is closed. InputConverterStreamTempl
class template with a derived class of InputTransform
allows you to define an input stream that internally converts data. Definition at line 48 of file InputConverterStream.h.
|
inlinenoexcept |
Gets the input stream for reading the pre-converted data.
Definition at line 56 of file InputConverterStream.h.
|
noexcept |
Sets the input stream for reading the pre-converted data.
[in] | istr | The pointer to the stream for reading the pre-converted data. |
0 | No error has occurred. |
EEXIST | The stream is already set. |
EINVAL | istr was set to NULL . |
EBADF | The SetTransform function has not executed. |
ENOMEM | Allocation of working memory failed. |
© Nintendo Co., Ltd. All rights reserved.