nlib
|
LZ4のフレームフォーマットに従ったデータを読むためのストリームクラスです。 [詳解]
#include "nn/nlib/oss/Lz4InputStream.h"
公開メンバ関数 | |
コンストラクタ、デストラクタ、及び初期化 | |
constexpr | Lz4InputStream () noexcept |
デフォルトコンストラクタです。実行後Init() による初期化を必要とします。 | |
virtual | ~Lz4InputStream () noexcept override |
デストラクタです。 | |
errno_t | Init () noexcept |
上記関数の引数省略版で、settings をデフォルト値で渡します。 | |
errno_t | Init (const Lz4InputStreamSettings &settings) noexcept |
動作オプションを指定して初期化を行います。成功した場合は0を返します。 [詳解] | |
![]() | |
errno_t | SetStream (InputStream *istr) noexcept |
変換前のデータを読み込む入力ストリームを設定します。 [詳解] | |
InputStream * | GetStream () const noexcept |
変換前のデータを読み込む入力ストリームを取得します。 [詳解] | |
![]() | |
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バイトを読み込みます。 [詳解] | |
int | Peek () noexcept |
ストリームを消費せずに次の1バイトを読み込みます。 [詳解] | |
size_t | Skip (size_t nbytes) noexcept |
nbytes を読み飛ばします。 [詳解] | |
size_t | Read (void *ptr, size_t nbytes) noexcept |
ptr で示されるメモリにnbytes 読み込みます。 [詳解] | |
template<size_t N> | |
size_t | Read (nlib_byte_t(&buf)[N]) noexcept |
上記関数のテンプレートオーバーロードです。 | |
bool | Close () noexcept |
ストリームを閉じます。成功した場合にはtrue を返します。 [詳解] | |
bool | Mark (size_t readlimit) noexcept |
現在の読み込み位置にGoBackToMark() で戻ることができるように設定します。 [詳解] | |
bool | GoBackToMark () noexcept |
最後にMark() を実行した読み込み位置に戻ります。 [詳解] | |
bool | IsMarkSupported () const noexcept |
このストリームがMark() とGoBackToMark() をサポートしていればtrue を返します。 | |
operator bool () const | |
オブジェクトが初期化済みで内部でエラーが発生していなければtrue 、発生していればfalse を返します。 | |
constexpr | InputStream () noexcept |
デフォルトコンストラクタです。 派生クラスから呼び出されます。 | |
virtual | ~InputStream () noexcept |
デストラクタです。 派生クラスから呼び出されます。 | |
その他の継承メンバ | |
![]() | |
void | SetBuffer (void *p, size_t nbytes, bool is_mark_supported, bool is_buf_readonly) noexcept |
InputStream が持つバッファを設定します。 [詳解] | |
void | SetError (errno_t e) const noexcept |
InputStream にエラーを設定します。 [詳解] | |
LZ4のフレームフォーマットに従ったデータを読むためのストリームクラスです。
Lz4InputStream.h の 24 行目に定義があります。
|
noexcept |
動作オプションを指定して初期化を行います。成功した場合は0を返します。
[in] | settings | 動作オプション |
0 | 成功した場合 |
EALREADY | 既に初期化済みの場合 |
ENOMEM | 内部でメモリ確保に失敗した場合 |
EINVAL | 動作オプションの指定が不正だった場合 |
EIO | 不明なエラーです。 |
© Nintendo Co., Ltd. All rights reserved.