nlib
nn::nlib::Base64InputStream クラスfinal

Base64でエンコードされたデータを読み込むためのクラスです。 [詳解]

#include "nn/nlib/Base64InputStream.h"

+ nn::nlib::Base64InputStream の継承関係図

公開メンバ関数

errno_t Init (CharOption char_option) noexcept
 オブジェクトを初期化します。引数についてはBase64Decoder::CharOptionをご覧ください。
 
errno_t Init () noexcept
 Init(Base64Decoder::BASE64_DEFAULT)を実行します。
 
- 基底クラス 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にエラーを設定します。 [詳解]
 

詳解

Base64でエンコードされたデータを読み込むためのクラスです。

説明
InputConverterStreamを基底クラスに持ちます。 InputStreamとして動作する際に読み込んだデータをBase64でデコードして返します。 InputConverterStream::SetStream()関数で、Base64文字列を読み込むストリームを設定して利用します。
変換される文字以外の文字が読み込まれた場合、以下のようになります。
  • CR, LF, スペース, 水平タブの場合はスキップ
  • それ以外の場合はエラー(EILSEQ)
パディング文字'='が不足している場合もエラー(EILSEQ)になります。
InputStream& is = ....;
Base64InputStream istr;
// 初期化
if (nlib_is_error(istr.Init())) { ERROR; }
// 読み込み元ストリームをセット
istr.SetStream(&is);
...
// InputStreamのI/Fを利用したistrに対する読み込み
...
// デストラクタでもClose()するが、エラーの確認ができない。
if (nlib_is_error(istr.Close())) { ERROR; }
if (nlib_is_error(is.Close())) { ERROR; }
覚え書き
2015-01-26版よりInit()による初期化が必要となっていることに注意してください。
参照
https://www.ietf.org/rfc/rfc2045.txt (RFC2045, Base64)
オブジェクトの状態遷移
オブジェクトの状態遷移の概略は以下のとおりです。
dot_inline_dotgraph_3.png

Base64InputStream.h11 行目に定義があります。


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