std::basic_streambuf<CharT,Traits>::overflow

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

入出力ライブラリ

I/Oマニピュレータ

出力関数 (C++23)

C形式I/O

バッファ

basic_streambuf

basic_filebuf

basic_stringbuf

basic_spanbuf (C++23)

strstreambuf (C++98/26*)

basic_syncbuf (C++20)

ストリーム

抽象化

ios_base

basic_ios

basic_istream

basic_ostream

basic_iostream

ファイルI/O

basic_ifstream

basic_ofstream

basic_fstream

文字列I/O

basic_istringstream

basic_ostringstream

basic_stringstream

配列I/O

basic_ispanstream (C++23)

basic_ospanstream (C++23)

basic_spanstream (C++23)

istrstream (C++98/26*)

ostrstream (C++98/26*)

strstream (C++98/26*)

同期出力

basic_osyncstream (C++20)

型

streamoff

streamsize

fpos

エラーカテゴリインターフェース

iostream_category (C++11)

io_errc (C++11)

 

std::basic_streambuf

公開メンバ関数 basic_streambuf::~basic_streambuf      ロケール basic_streambuf::pubimbue basic_streambuf::getloc 位置付け basic_streambuf::pubsetbuf basic_streambuf::pubseekoff basic_streambuf::pubseekpos basic_streambuf::pubsync 取得領域 basic_streambuf::in_avail basic_streambuf::snextc basic_streambuf::sbumpc basic_streambuf::sgetc basic_streambuf::sgetn 配置領域 basic_streambuf::sputc basic_streambuf::sputn 戻し basic_streambuf::sputbackc basic_streambuf::sungetc

Protected member functions basic_streambuf::basic_streambuf basic_streambuf::operator= (C++11) basic_streambuf::swap (C++11) ロケール basic_streambuf::imbue 位置付け basic_streambuf::setbuf basic_streambuf::seekoff basic_streambuf::seekpos basic_streambuf::sync 取得領域 basic_streambuf::showmanyc basic_streambuf::underflow basic_streambuf::uflow basic_streambuf::xsgetn basic_streambuf::ebackbasic_streambuf::gptrbasic_streambuf::egptr basic_streambuf::gbump basic_streambuf::setg 配置領域 basic_streambuf::xsputn basic_streambuf::overflow basic_streambuf::pbasebasic_streambuf::pptrbasic_streambuf::epptr basic_streambuf::pbump basic_streambuf::setp 戻し basic_streambuf::pbackfail

 

protected: virtual int_type overflow( int_type ch = Traits::eof() );

この関数の意図は、ストリームバッファの[[cpp/io/basic_streambuf|出力領域]から関連付けられた文字シーケンスへ文字を転送することです。

形式的には、この関数は出力領域に少なくとも1文字分のスペースがあることを保証します。基底クラスのバージョンは常に失敗し、成功する可能性のある実装は派生クラスでのみ提供できます（実装要件を参照）。標準ライブラリは、std::strstreambuf::overflow(), (C++26まで)std::basic_stringbuf::overflow() および std::basic_filebuf::overflow() を提供します。

パラメータ

文字

-

出力領域に格納する文字

戻り値

Traits::eof()

実装要件

この仮想関数をオーバーライドするすべての定義は、以下の制約に従わなければなりません。そうでない場合、動作は未定義となります。

• この関数の効果は、*保留シーケンス* の初期部分シーケンスを消費することです。保留シーケンスは、以下のシーケンスの連結として定義されます。
  • 出力領域（形式的には、pbase() が null の場合は空のシーケンス、それ以外の場合は pptr() - pbase() 個の文字（pbase() から始まる））
  • 文字 ch、または ch が EOF の場合は何も（形式的には、Traits::eq_int_type(ch, Traits::eof()) が true を返す場合）。
• 消費後、出力領域ポインタは、残りの文字（もしあれば）を保持するように更新されます。形式的には、保留シーケンスのうち消費されなかった文字の数を r とすると
  • もし r がゼロでない場合、pbase() および pptr() は、以下のすべての条件が満たされるように設定されます。
    • pptr() - pbase() は r です。
    • pbase() から始まる r 個の文字が、関連付けられた出力ストリームです。
  • もし r がゼロ（保留シーケンスのすべての文字が消費された）の場合、pbase() は null 値に設定されるか、または pbase() と pptr() は両方とも同じ非 null 値に設定されます。
• 関連付けられた出力ストリームへの文字の追加に失敗した場合、または上記の規則に従って pbase() および pptr() を確立できなかった場合に、関数は失敗する可能性があります。
• 関数が成功した場合、Traits::eof() 以外の値を返します。通常、成功を示すために ch が返されますが、Traits::eq_int_type(ch, Traits::eof()) が true を返す場合は、Traits::not_eof(ch) が返されます。
• 関数が失敗した場合、Traits::eof() を返すか、例外をスローします。

注記

sputc() および sputn() は、オーバーフローが発生した場合（pptr() == nullptr または pptr() >= epptr()）にこの関数を呼び出します。

例

このコードを実行

#include <array>
#include <cstddef>
#include <iostream>
 
// Buffer for std::ostream implemented by std::array
template<std::size_t size, class CharT = char>
struct ArrayedStreamBuffer : std::basic_streambuf<CharT>
{
    using Base = std::basic_streambuf<CharT>;
    using char_type = typename Base::char_type;
    using int_type = typename Base::int_type;
 
    ArrayedStreamBuffer()
    {
        // put area pointers to work with 'buffer'
        Base::setp(buffer.data(), buffer.data() + size);
    }
 
    int_type overflow(int_type ch) 
    {
        std::cout << "overflow\n";
        return Base::overflow(ch);
    }
 
    void print_buffer()
    {
        for (char_type i : buffer)
        {
            if (i == 0)
                std::cout << "\\0";
            else
                std::cout << i;
            std::cout << ' ';
        }
        std::cout << '\n';
    }
 
private:
    std::array<char_type, size> buffer{}; // value-initialize buffer
};
 
int main()
{
    ArrayedStreamBuffer<10> streambuf;
    std::ostream stream(&streambuf);
 
    stream << "hello";
    streambuf.print_buffer();
    if (stream.good())
        std::cout << "stream is good\n";
 
    stream << "world";
    streambuf.print_buffer();
    if (stream.good())
        std::cout << "stream is good\n";
 
    stream << "!";
    streambuf.print_buffer();
    if (!stream.good())
        std::cout << "stream is not good\n";
}

出力

h e l l o \0 \0 \0 \0 \0
stream is good
h e l l o w o r l d 
stream is good
overflow
h e l l o w o r l d 
stream is not good

関連項目

uflow [virtual]	関連付けられた入力シーケンスから取得領域に文字を読み込み、次のポインタを進める (virtual protected member function)
underflow [virtual]	関連付けられた入力シーケンスから取得領域に文字を読み込む (virtual protected member function)
overflow [virtual]	ファイルバッファの格納領域から、関連付けられたファイルへ文字を書き込みます。 (std::basic_filebuf<CharT,Traits> の保護仮想メンバ関数)
overflow [virtual]	出力シーケンスに文字を追加する (std::basic_stringbuf<CharT,Traits,Allocator> の仮想 protected メンバ関数)
overflow [virtual]	出力シーケンスに文字を追加します。動的で凍結されていない場合は、バッファを再割り当てまたは最初に割り当てることができます。 (std::strstreambuf の仮想 protected メンバ関数)