nlib
|
The base class for classes that act internally like OutputStream
to convert data.
More...
#include "nn/nlib/OutputConverterStream.h"
Public Member Functions | |
errno_t | SetStream (OutputStream *ostr) noexcept |
Sets an output stream as the base stream. More... | |
OutputStream * | GetStream () const noexcept |
Gets the input stream that will be the base stream. 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 integer. More... | |
bool | Write (int b) noexcept |
Writes one byte of data to the stream. More... | |
bool | Write (const void *p, size_t n) noexcept |
Writes n bytes of data to the stream. More... | |
bool | WriteGather (const nlib_fd_iovec *iov, int iovcnt) noexcept |
Writes data from multiple non-continuous buffers to a stream. More... | |
bool | Flush () noexcept |
Flushes the stream. More... | |
bool | Close () noexcept |
Closes the stream after it has been flushed. Returns true if successful. More... | |
errno_t | GetErrorValue () const noexcept |
Gets the error value. More... | |
BufferingMode | GetBufferingMode () const noexcept |
Gets the buffering mode. | |
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 | OutputStream () noexcept |
Instantiates the object with default parameters (default constructor). | |
virtual | ~OutputStream () noexcept |
Destructor. | |
Additional Inherited Members | |
![]() | |
enum | BufferingMode { kBufferingModeBlockBuffered = 0, kBufferingModeLineBuffered, kBufferingModeUnbuffered } |
The buffering mode for OutputStream . More... | |
![]() | |
void | ResetBuffer (void *p, size_t nbytes) noexcept |
Sets the buffer held by OutputStream . More... | |
void | SetError (errno_t e) const noexcept |
Sets an error to OutputStream . More... | |
![]() | |
BufferingMode | m_BufferingMode |
Stores the buffering mode. More... | |
The base class for classes that act internally like OutputStream
to convert data.
SetStream
function to set an output stream and use the OutputStream
interface to write the data, the data is converted in an internal process and written to the output stream. Users normally do not make direct use of this feature. OutputTransform::GetWorkBuffer()
function registers a buffer that OutputStream
will use. OutputStream
places data provided by the user in this buffer. The OutputTransform::Transform()
function reads data from OutputStream
and writes that data in the converted format. The OutputTransform::OnSetStream()
function writes a process to be performed when OutputConverterStream::SetStream()
is called. The OutputTransform::OnClose()
function is called when a stream is closed. OutputConverterStreamTempl
class template with a derived class of OutputTransform
allows you to define an input stream that internally converts data. Definition at line 40 of file OutputConverterStream.h.
|
inlinenoexcept |
Gets the input stream that will be the base stream.
Definition at line 47 of file OutputConverterStream.h.
|
noexcept |
Sets an output stream as the base stream.
[in] | ostr | A pointer to the base string. |
0 | No error has occurred. |
EEXIST | The stream is already set. |
EINVAL | ostr was set to NULL . |
EBADF | The SetTransform function has not executed. |
ENOMEM | Allocation of working memory failed. |
© Nintendo Co., Ltd. All rights reserved.