nlib
|
The class that uses zlib
to decompress data and write the data to a stream.
More...
#include "nn/nlib/ZlibOutputStream.h"
Public Member Functions | |
errno_t | Init () noexcept |
Initializes using the default settings. More... | |
errno_t | Init (const ZlibOutputStreamSettings &settings) noexcept |
Configures the buffer and the other settings to use for streaming according to the values specified in the settings parameter. More... | |
Basic Member Functions | |
constexpr | ZlibOutputStream () noexcept |
Instantiates the object with default parameters (default constructor). | |
![]() | |
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 no internal error has occurred. | |
constexpr | OutputStream () noexcept |
Instantiates the object with default parameters (default constructor). | |
virtual | ~OutputStream () noexcept |
Destructor. Does not do anything. | |
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 class that uses zlib
to decompress data and write the data to a stream.
zlib
. Even large amounts of data can be streamed and written. Init
function to configure the buffer and the like, using the SetStream
function to associate the base stream, and then writing the data in the same way as OutputStream
. When you close this stream, the base stream is flushed and detached, reverting to the state before SetStream
was called. The base stream itself is not closed. zlib
errors. Z_STREAM_ERROR
-> EIO
. Z_MEM_ERROR
-> ENOMEM
. Z_BUF_ERROR
-> ENOBUFS
. EIO
. Definition at line 57 of file ZlibOutputStream.h.
|
inlinenoexcept |
Initializes using the default settings.
0
indicates an error.deflateInit2
function is called inside the SetStream
function to initialize for data compression. 31
, memLevel is set to 8
, and strategy is set to Z_DEFAULT_STRATEGY
. zalloc, zfree, and opaque for z_stream are all set to Z_NULL
. EEXIST
. NULL
, the function returns EINVAL
. deflateInit2
function of zlib
are converted as follows. ENOMEM
. EINVAL
. ENOTSUP
. Definition at line 61 of file ZlibOutputStream.h.
|
noexcept |
Configures the buffer and the other settings to use for streaming according to the values specified in the settings parameter.
[in] | settings | The settings data for the buffer and other settings. |
0 | No error occurred. |
EALREADY | The Init function is already running. |
EINVAL | The buffer size is smaller than 1024, or only one of the buffers specified in the settings parameter is NULL . |
ENOMEM | Dynamic allocation of a buffer has failed. |
© 2012-2017 Nintendo Co., Ltd. All rights reserved.