nlib
nn::nlib::oss::Lz4InputStream クラスfinal

LZ4のフレームフォーマットに従ったデータを読むためのストリームクラスです。 [詳解]

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

+ nn::nlib::oss::Lz4InputStream の継承関係図

公開メンバ関数

errno_t Init () noexcept
 ストリームをデフォルトの設定で初期化します。 [詳解]
 
errno_t Init (const Lz4InputStreamSettings &settings) noexcept
 ストリームを初期化します。 [詳解]
 
基本的なメンバ関数
 Lz4InputStream () noexcept
 デフォルトコンストラクタです。更にInit()で初期化する必要があります。
 
virtual ~Lz4InputStream () noexcept override
 デストラクタです。
 
- 基底クラス nn::nlib::InputConverterStream に属する継承公開メンバ関数
errno_t SetStream (InputStream *istr) noexcept
 変換前のデータを読み込む入力ストリームを設定します。 [詳解]
 
InputStreamGetStream () const noexcept
 変換前のデータを読み込む入力ストリームを取得します。 [詳解]
 
- 基底クラス nn::nlib::InputStream に属する継承公開メンバ関数
errno_t GetErrorValue () const noexcept
 エラー値を取得します。 [詳解]
 
size_t Pos () const noexcept
 ストリーム上の現在位置を返します。 [詳解]
 
uint64_t Pos64 () const noexcept
 ストリーム上の現在位置を64bit値で返します。 [詳解]
 
bool IsEos () noexcept
 ストリームを最後まで読み終えている場合trueを返します。最後まで読み終えていない場合やエラーが発生している場合はfalseを返します。 [詳解]
 
int Read () noexcept
 ストリームから1バイトを読み込みます。 [詳解]
 
NLIB_CHECK_RESULT int Peek () noexcept
 ストリームを消費せずに次の1バイトを読み込みます。 [詳解]
 
size_t Skip (size_t nbytes) noexcept
 nbytes を読み飛ばします。 [詳解]
 
size_t Read (void *ptr, size_t nbytes) noexcept
 ptr で示されるメモリにnbytes 読み込みます。 [詳解]
 
bool Close () noexcept
 ストリームを閉じます。成功した場合にはtrueを返します。 [詳解]
 
 operator bool () const
 内部でエラーが発生していなければtrueを返します。
 
constexpr InputStream () noexcept
 コンストラクタです。派生クラスから呼び出されます。
 
virtual ~InputStream () noexcept
 デストラクタです。派生クラスから呼び出されます。
 

その他の継承メンバ

- 基底クラス nn::nlib::InputStream に属する継承限定公開メンバ関数
void ResetBuffer (void *p, size_t nbytes) noexcept
 InputStreamが持つバッファを設定します。 [詳解]
 
void SetError (errno_t e) const noexcept
 InputStreamにエラーを設定します。 [詳解]
 

詳解

LZ4のフレームフォーマットに従ったデータを読むためのストリームクラスです。

説明
LZ4のフレームフォーマットはマルチスレッドでのデコードにも対応していますが、このクラスはシングルスレッドでのみ動作します。
オブジェクトの状態遷移
オブジェクトの状態遷移の概略は以下のとおりです。
dot_inline_dotgraph_15.png

Lz4InputStream.h24 行目に定義があります。

関数詳解

◆ Init() [1/2]

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

ストリームをデフォルトの設定で初期化します。

戻り値
0成功しました。
ENOMEMメモリの確保に失敗しました。
EALREADY既に初期化されています。
EIO不明なエラーです。

Lz4InputStream.h28 行目に定義があります。

◆ Init() [2/2]

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

ストリームを初期化します。

引数
[in]settings初期化オプション
戻り値
0成功しました。
ENOMEMメモリの確保に失敗しました。
EALREADY既に初期化されています。
EIO不明なエラーです。

このクラス詳解は次のファイルから抽出されました: