xsputn.md

xsputn

• streambuf[meta header]
• std[meta namespace]
• basic_streambuf[meta class]
• function[meta id-type]

namespace std {
  template<class CharT, class Traits = char_traits<CharT>>
  class basic_streambuf {
  protected:
    virtual streamsize xsputn(const char_type* s, streamsize n);

    ……
  };
}

• streamsize[link /reference/ios/type-streamsize.md]

概要

出力列に複数文字を書き込む。

効果

sからn文字を、sputc()を繰り返し呼び出したかのようにして出力列に書き込む。n文字を書き込むか、sputc()の呼び出しがTraits::eof()を返す状況になった時点で、書き込みを停止する。

戻り値

書き込んだ文字数。

備考

• pptr() == epptr()となった時点でこの関数がoverflow()を呼び出すか、それとも別の手段で同じ効果を実現するかは、未規定である。
  • そのため、派生クラスでoverflow()のみをオーバーライドしても、xsputn()経由の出力でそれが呼ばれるとは限らない。効率のためにxsputn()自体をオーバーライドする処理系があるためである。

例

#include <iostream>
#include <streambuf>

// streambufを継承したクラス
class dummy_buf : public std::streambuf {
public:
    dummy_buf(char* begin, char* end) {
        // 出力列の領域を指定
        setp(begin, end);
    }
    std::streamsize xsputn(const char_type* s, std::streamsize n) override {
        // ベースクラスのxsputn()を呼ぶ
        return std::streambuf::xsputn(s, n);
    }
};

int main() {
    char space[10] = {};
    dummy_buf buf{space, space + 5};
    std::cout << buf.xsputn("ABC", 3) << std::endl;  // 3文字全て書き込む
    std::cout << buf.xsputn("ABC", 3) << std::endl;  // 2文字のみ書き込む
    std::cout << space << std::endl;  // 書き込んだ文字列を出力
}

• std::streambuf::xsputn[color ff0000]

出力

3
2
ABCAB

バージョン

言語

• C++98

関連項目

• sputn()

参照

• LWG Issue 565. xsputn inefficient
  • C++11で、pptr() == epptr()となったときにoverflow()を呼び出すかどうかが未規定であると明記された。デバイスへ直接書き出すなど、sputc()やoverflow()を経由しない効率的な実装を許すためであり、それ以前も同様の実装が行われていた