nlib
nn::nlib::oss::Lz4InputStream Class Referencefinal

The stream class to read data according to the LZ4 frame format. More...

#include "nn/nlib/oss/Lz4InputStream.h"

+ Inheritance diagram for nn::nlib::oss::Lz4InputStream:

Public Member Functions

errno_t Init () noexcept
 Initializes the stream with the default settings. More...
 
errno_t Init (const Lz4InputStreamSettings &settings) noexcept
 Initializes a stream. More...
 
Basic Member Functions
 Lz4InputStream () noexcept
 Instantiates the object with default parameters (default constructor). Must be initialized with Init().
 
virtual ~Lz4InputStream () noexcept override
 Destructor.
 
- 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...
 
NLIB_CHECK_RESULT 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.
 

Additional Inherited Members

- 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 stream class to read data according to the LZ4 frame format.

Description
Although the LZ4 frame format also supports multi-thread decoding, this class runs only in a single thread.
The transition of the object state.
The overview of the object state transitions is described below:
dot_inline_dotgraph_15.png

Definition at line 24 of file Lz4InputStream.h.

Member Function Documentation

§ Init() [1/2]

nn::nlib::oss::Lz4InputStream::Init ( )
inlinenoexcept

Initializes the stream with the default settings.

Return values
0Success.
ENOMEMFailed to allocate memory.
EALREADYAlready initialized.
EIOAn unknown error.

Definition at line 28 of file Lz4InputStream.h.

§ Init() [2/2]

nn::nlib::oss::Lz4InputStream::Init ( const Lz4InputStreamSettings settings)
noexcept

Initializes a stream.

Parameters
[in]settingsThe default options.
Return values
0Success.
ENOMEMFailed to allocate memory.
EALREADYAlready initialized.
EIOAn unknown error.

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