4. noemit_on_flush

最終更新日時(UTC):
が更新

履歴 編集

function template
<ostream>

std::noemit_on_flush(C++20)

namespace std {
  template<class charT, class traits>
  basic_ostream<charT, traits>& noemit_on_flush(basic_ostream<charT, traits>& os);
}

概要

このマニピュレータは、実際にはstd::basic_osyncstreamに対して使用されることが期待される。std::basic_osyncstreamのベースとなるstd::basic_syncbufの同期時排出ポリシーをfalseに変更する。つまり、std::basic_osyncstreamのオブジェクトにflush()が呼ばれた際、文字が転送されないようになる。デフォルトでは、文字は転送されないようになっているため、このマニピュレータを明示的に使用する必要はない。
また、対になるマニピュレータとして、emit_on_flushが存在する。

効果

os.rdbuf()がstd::basic_syncbuf<charT、traits、Allocator>*である場合、これをbufとすると、buf->set_emit_on_sync(false)を呼び出す。
それ以外の場合、このマニピュレータは効果がない。

戻り値

os

備考

本関数は、直接呼ぶのではなく、マニピュレータ関数へのポインタを引数に取る出力演算子（operator<<、挿入演算子、インサータとも呼ばれる）を通じて呼び出されるのが一般的である。

例

#include <iostream>
#include <syncstream>

int main()
{
  std::osyncstream bout{std::cout};
  bout << "Hello, World!\n";

  bout << std::emit_on_flush;

  bout << std::flush; // 通常はここで保留中の文字は転送されないが、
                      // emit_on_flush を呼び出し、同期時排出ポリシーが true となっているため、
                      // ここで文字が転送される

  bout << "Goodbye, Planet!";
  bout << std::noemit_on_flush;

  bout << std::flush; // ここでは、文字は転送されない
} // bout 破棄時に bout.emit() が呼ばれ、ここで文字が転送される

出力

Hello, World!
Goodbye, Planet!

バージョン

言語

  • C++20

参照