cpprefjp.github.io/reference/streambuf/basic_streambuf.html at master · cpprefjp/cpprefjp.github.io

627 lines (567 loc) · 21.8 KB
<!doctype html>
<html class="cpprefjp" lang="ja" itemscope="" itemtype="http://schema.org/WebPage">
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-NXNBNVBTJS"></script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());
  gtag('config', 'G-NXNBNVBTJS');
        <meta charset="UTF-8">
        <title>basic_streambuf - cpprefjp C++日本語リファレンス</title>
        <meta name="viewport" content="width=device-width,initial-scale=1">
        <meta name="keywords" content="
  C++,標準ライブラリ,リファレンス,ドキュメント,STL,std,streambuf,std,class template,streambuf,wstreambuf
        <meta name="title" content="basic_streambuf - cpprefjp C++日本語リファレンス" />
        <meta itemprop="name" content="basic_streambuf - cpprefjp C++日本語リファレンス" />
        <meta property="og:title" content="basic_streambuf - cpprefjp C++日本語リファレンス" />
        <meta property="og:url" content="https://cpprefjp.github.io/reference/streambuf/basic_streambuf.html" />
        <meta property="og:site_name" content="cpprefjp - C++日本語リファレンス" />
        <meta property="og:type" content="article" />
        <meta property="og:description" content="`basic_streambuf`は、ストリームバッファを表現するクラスである。" />
        <meta name="twitter:card" content="summary" />
        <meta name="twitter:title" content="basic_streambuf - cpprefjp C++日本語リファレンス" />
        <meta name="twitter:url" content="https://cpprefjp.github.io/reference/streambuf/basic_streambuf.html" />
        <meta name="twitter:description" content="`basic_streambuf`は、ストリームバッファを表現するクラスである。" />
  <link rel="alternate" type="application/atom+xml" title="Atom" href="https://cpprefjp.github.io/rss.xml" />
<link rel="apple-touch-icon" sizes="180x180" href="../../static/favicons/apple-touch-icon.png?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95">
<link rel="icon" type="image/png" sizes="32x32" href="../../static/favicons/favicon-32x32.png?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95">
<link rel="icon" type="image/png" sizes="16x16" href="../../static/favicons/favicon-16x16.png?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95">
<link rel="manifest" href="../../manifest.json?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95">
<meta name="theme-color" content="#f5f8fc">
<link rel="stylesheet" href="../../static/pygments/default.css?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95">
<!-- <link rel="stylesheet" href="../../static/css/root.css"> -->
<link href="../../static/kunai/css/kunai-stage-0.css?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95" rel="stylesheet">
<link href="../../static/kunai/css/kunai-stage-1.css?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95" rel="stylesheet">
<link href="../../static/kunai/css/kunai-stage-2.css?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95" rel="stylesheet">
<link href="../../static/kunai/css/kunai-stage-3.css?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95" rel="stylesheet">
<script type="text/javascript" src="../../static/kunai/js/kunai-vendor.js?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95"></script>
<script type="text/javascript" src="../../static/kunai/js/kunai.js?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95"></script>
<script type="text/javascript">
  document.addEventListener('DOMContentLoaded', function() {
    var kn = new Kunai;
    kn.cpprefjp();
    </head>
<header data-kunai-mdinfo="{&#34;meta&#34;: {&#34;header&#34;: [&#34;streambuf&#34;], &#34;namespace&#34;: [&#34;std&#34;], &#34;id-type&#34;: [&#34;class template&#34;], &#34;alias&#34;: [&#34;streambuf,wstreambuf&#34;]}, &#34;sources&#34;: [], &#34;page_id&#34;: [&#34;reference&#34;, &#34;streambuf&#34;, &#34;basic_streambuf&#34;]}">
  <nav class="navbar navbar-default" role="navigation">
    <div class="container-fluid">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-collapse">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="../../index.html">
          <div class="title-wrapper clearfix">
            <div class="title">cpprefjp - C++日本語リファレンス</div>
          </div>
        </a>
      </div>
      <div class="collapse navbar-collapse" id="navbar-collapse">
        <ul class="nav navbar-nav navbar-right">
          <li>
            <div class="google-search">
  (function() {
    var cx = '013316413321391058734:ji_u66hl7hq';
    var gcse = document.createElement('script');
    gcse.type = 'text/javascript';
    gcse.async = true;
    gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
        '//www.google.com/cse/cse.js?cx=' + cx;
    var s = document.getElementsByTagName('script')[0];
    s.parentNode.insertBefore(gcse, s);
<div class="gcse-search"></div>
            </div>
          </li>
          <li>
  <a href="https://github.com/cpprefjp/site">GitHub Project</a>
        </ul>
      </div>
        <main id="main" role="main">
            <div class="container-fluid">
<div class="row">
  <div class="col-sm-9 col-sm-push-3" itemscope itemtype="http://schema.org/Article">
    <div class="row">
      <div class="col-sm-12 google-search-result">
        <gcse:searchresults></gcse:searchresults>
      </div>
    <div class="row">
      <div class="col-sm-12 content-header">
  <ol class="breadcrumb">
      <li  itemscope itemtype="http://www.schema.org/SiteNavigationElement">
        <span>
            <a href="../../index.html" itemprop="url">
                <i class="fa fa-fw fa-home"></i>
            </a>
        </span>
      </li>
      <li  itemscope itemtype="http://www.schema.org/SiteNavigationElement">
        <span>
            <a href="../../reference.html" itemprop="url">
                <span itemprop="name">リファレンス</span>
            </a>
        </span>
      </li>
      <li  itemscope itemtype="http://www.schema.org/SiteNavigationElement">
        <span>
            <a href="../../reference/streambuf.html" itemprop="url">
                <span itemprop="name">streambuf</span>
            </a>
        </span>
      </li>
      <li class="active" itemscope itemtype="http://www.schema.org/SiteNavigationElement">
        <span>
              <span itemprop="name">basic_streambuf</span>
        </span>
      </li>
  <div class="crsearch"></div>
      </div>
    <div class="row">
      <div class="col-sm-12 edit-button">
    <p class="text-right"><small>
      最終更新日時(UTC):
      <span itemprop="datePublished" content="2026-01-08T11:45:05">
        2026年01月08日 11時45分05秒
      </span>
      <br/>
      <span itemprop="author" itemscope itemtype="http://schema.org/Person">
        <span itemprop="name">yoh</span>
      </span>
    </small></p>
        <p class="text-right">
          <a class="history" target="_blank" href="https://github.com/cpprefjp/site/commits/master/reference/streambuf/basic_streambuf.md">
            <span class="fa fa-fw fa-clock-o fa-flip-horizontal"></span>履歴
          </a>
          <a class="edit" target="_blank" href="https://github.com/cpprefjp/site/edit/master/reference/streambuf/basic_streambuf.md">
            <span class="fa fa-fw fa-pencil"></span>編集
          </a>
        </p>
      </div>
    <div class="row">
      <div class="col-sm-12 content-body">
  <div class="identifier-type">class template</div><div class="header">&lt;streambuf&gt;</div><h1 itemprop="name"><span class="namespace" title="namespace std">std::</span><span class="token">basic_streambuf</span></h1>
<div itemprop="articleBody"><p><div class="codehilite"><pre><span></span><code><span class="k">namespace</span><span class="w"> </span><span class="nn">std</span><span class="w"> </span><span class="p">{</span>
<span class="w">  </span><span class="k">template</span><span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="nc">CharT</span><span class="p">,</span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">Traits</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n"><a href="../string/char_traits.html">char_traits</a></span><span class="o">&lt;</span><span class="n">CharT</span><span class="o">&gt;&gt;</span>
<span class="w">  </span><span class="k">class</span><span class="w"> </span><span class="nc">basic_streambuf</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="err">……</span><span class="w"> </span><span class="p">};</span>
<span class="w">  </span><span class="k">using</span><span class="w"> </span><span class="n">streambuf</span><span class="w">  </span><span class="o">=</span><span class="w"> </span><span class="n">basic_streambuf</span><span class="o">&lt;</span><span class="kt">char</span><span class="o">&gt;</span><span class="p">;</span>
<span class="w">  </span><span class="k">using</span><span class="w"> </span><span class="n">wstreambuf</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">basic_streambuf</span><span class="o">&lt;</span><span class="kt">wchar_t</span><span class="o">&gt;</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div>
<h2>概要</h2>
<p><code>basic_streambuf</code>は、ストリームバッファを表現するクラスである。
入力ストリーム・出力ストリームに対して、実際の入出力機能を提供する。</p>
<p>テンプレートパラメータとして文字型を受け取るようになっており、使用を容易にするため、以下のパラメータ設定済みエイリアスが定義されている。
このエイリアスは<code>&lt;streambuf&gt;</code>ヘッダと<code>&lt;iosfwd&gt;</code>ヘッダで定義されている。</p>
<table border="1" bordercolor="#888" style="border-collapse:collapse">
<th>エイリアス</th>
<th>説明</th>
<th>対応バージョン</th>
<td><code>streambuf</code></td>
<td><code>char</code>型。ASCII、UTF-8等のマルチバイト文字列や、バイナリデータとして使用する。</td>
<td><code>wstreambuf</code></td>
<td><code>wchar_t</code>型。ワイド文字列として使用する。</td>
<h3>ストリームバッファについて</h3>
<p><code>basic_streambuf</code>はストリームバッファを取り扱うクラステンプレートである。
ストリームバッファは入力列と出力列からなる。</p>
<p>入力列と出力列それぞれについて、<code>basic_streambuf</code>から直接アクセスできる部分は全体の一部分のみである（もちろん、全体がそこに収まっている場合もある）。
その直接アクセスできる部分列は<code>CharT</code>の配列として表現され、先頭・現在位置・終端の3つのポインタで指し示す。
ただし、先頭・現在位置・終端のポインタがすべてnullptrである状態もありえる。</p>
<p><code>basic_streambuf</code>に対するすべての入出力処理は、この3つ組のポインタに対する処理や列全体と部分列の対応を変更する処理として実現されている。</p>
<p>たとえば<code>basic_filebuf</code>では、ファイルの内容を列全体と見なし、basic_filebuf内でバッファリングしている部分が先頭・現在位置・終端の3つのポインタで指し示されるという構成になる。</p>
<h2>メンバ</h2>
<li>publicな関数: 主に<code>basic_streambuf</code>を利用する側に対するもの。</li>
<li>protectedな関数: <code>basic_streambuf</code>の派生クラスを作る側に対するもの。</li>
<li>protected virtualな関数: <code>basic_streambuf</code>の派生クラスを作る際に必要に応じてオーバーライドするもの。</li>
<table border="1" bordercolor="#888" style="border-collapse:collapse">
<th>名前</th>
<th>説明</th>
<th>対応バージョン</th>
<td><code>char_type</code></td>
<td>テンプレート仮引数<code>CharT</code></td>
<td><code>int_type</code></td>
<td><code>Traits::int_type</code></td>
<td><code>pos_type</code></td>
<td><code>Traits::pos_type</code></td>
<td><code>off_type</code></td>
<td><code>Traits::off_type</code></td>
<td><code>traits_type</code></td>
<td>テンプレート仮引数<code>Traits</code></td>
<h3>構築・破棄</h3>
<table border="1" bordercolor="#888" style="border-collapse:collapse">
<th>名前</th>
<th>説明</th>
<th>対応バージョン</th>
<td><code><a href="basic_streambuf/op_constructor.html">(constructor)</a></code></td>
<td>コンストラクタ (protected)</td>
<td><code>(destructor)</code></td>
<td>デストラクタ (virtual)</td>
<td><code><a href="basic_streambuf/op_assign.html">operator=</a></code></td>
<td>コピー代入 (protected)</td>
<td>C++11</td>
<td><code><a href="basic_streambuf/swap.html">swap</a></code></td>
<td>値の交換 (protected)</td>
<td>C++11</td>
<h3>ロケール</h3>
<table border="1" bordercolor="#888" style="border-collapse:collapse">
<th>名前</th>
<th>説明</th>
<th>対応バージョン</th>
<td><code><a href="basic_streambuf/getloc.html">getloc</a></code></td>
<td>現在のロケールを返す。</td>
<td><code><a href="basic_streambuf/pubimbue.html">pubimbue</a></code></td>
<td>ロケールを設定する。</td>
<td><code><a href="basic_streambuf/imbue.html">imbue</a></code></td>
<td>ロケールを設定する (protected virtual)。</td>
<h3>バッファとポジショニング</h3>
<table border="1" bordercolor="#888" style="border-collapse:collapse">
<th>名前</th>
<th>説明</th>
<th>対応バージョン</th>
<td><code><a href="basic_streambuf/pubsetbuf.html">pubsetbuf</a></code></td>
<td>バッファ領域を与える。</td>
<td><code><a href="basic_streambuf/pubseekoff.html">pubseekoff</a></code></td>
<td>相対位置指定での移動。</td>
<td><code><a href="basic_streambuf/pubseekpos.html">pubseekpos</a></code></td>
<td>絶対位置指定での移動。</td>
<td><code><a href="basic_streambuf/pubsync.html">pubsync</a></code></td>
<td>出力列の同期。</td>
<td><code><a href="basic_streambuf/setbuf.html">setbuf</a></code></td>
<td>バッファ領域を与える (protected virtual)。</td>
<td><code><a href="basic_streambuf/seekoff.html">seekoff</a></code></td>
<td>相対位置指定での移動 (protected virtual)。</td>
<td><code><a href="basic_streambuf/seekpos.html">seekpos</a></code></td>
<td>絶対位置指定での移動 (protected virtual)。</td>
<td><code><a href="basic_streambuf/sync.html">sync</a></code></td>
<td>出力列の同期 (protected virtual)。</td>
<h3>入力</h3>
<table border="1" bordercolor="#888" style="border-collapse:collapse">
<th>名前</th>
<th>説明</th>
<th>対応バージョン</th>
<td><code><a href="basic_streambuf/in_avail.html">in_avail</a></code></td>
<td>現在の入力列の読み取り可能な文字数を返す。</td>
<td><code><a href="basic_streambuf/snextc.html">snextc</a></code></td>
<td>入力列の1文字を捨てて、次の文字を読み取る。</td>
<td><code><a href="basic_streambuf/sbumpc.html">sbumpc</a></code></td>
<td>入力列の現在位置の文字を読み取り、現在位置を1文字進める。</td>
<td><code><a href="basic_streambuf/uflow.html">uflow</a></code></td>
<td>入力部分列の領域を消費し切った際の処理 (protected virtual)。</td>
<td><code><a href="basic_streambuf/sgetc.html">sgetc</a></code></td>
<td>入力列の現在位置の文字を読み取る。</td>
<td><code><a href="basic_streambuf/underflow.html">underflow</a></code></td>
<td>入力部分列の領域を消費し切った際の処理 (protected virtual)。</td>
<td><code><a href="basic_streambuf/sgetn.html">sgetn</a></code></td>
<td>入力列から複数文字を読み取る。</td>
<td><code><a href="basic_streambuf/xsgetn.html">xsgetn</a></code></td>
<td>入力列から複数文字を読み取る (protected virtual)。</td>
<td><code><a href="basic_streambuf/showmanyc.html">showmanyc</a></code></td>
<td>ブロックせずに読み取れると期待される文字数を得る (protected virtual)。</td>
<h3>入力の読み戻し</h3>
<table border="1" bordercolor="#888" style="border-collapse:collapse">
<th>名前</th>
<th>説明</th>
<th>対応バージョン</th>
<td><code><a href="basic_streambuf/sputbackc.html">sputbackc</a></code></td>
<td>任意の1文字を入力列に戻す。</td>
<td><code><a href="basic_streambuf/sungetc.html">sungetc</a></code></td>
<td>直前に読み取った1文字を入力列に戻す。</td>
<td><code><a href="basic_streambuf/pbackfail.html">pbackfail</a></code></td>
<td>1文字を入力列に戻す (protected virtual)。</td>
<h3>入力部分列の操作</h3>
<table border="1" bordercolor="#888" style="border-collapse:collapse">
<th>名前</th>
<th>説明</th>
<th>対応バージョン</th>
<td><code><a href="basic_streambuf/eback.html">eback</a></code></td>
<td>入力部分列の先頭へのポインタを返す (protected)。</td>
<td><code><a href="basic_streambuf/gptr.html">gptr</a></code></td>
<td>入力部分列の現在位置へのポインタを返す (protected)。</td>
<td><code><a href="basic_streambuf/egptr.html">egptr</a></code></td>
<td>入力部分列の終端へのポインタを返す (protected)。</td>
<td><code><a href="basic_streambuf/gbump.html">gbump</a></code></td>
<td>入力部分列の現在位置を指定した量だけ進める (protected)。</td>
<td><code><a href="basic_streambuf/setg.html">setg</a></code></td>
<td>入力部分列の各ポインタを設定する (protected)。</td>
<h3>出力</h3>
<table border="1" bordercolor="#888" style="border-collapse:collapse">
<th>名前</th>
<th>説明</th>
<th>対応バージョン</th>
<td><code><a href="basic_streambuf/sputc.html">sputc</a></code></td>
<td>出力列に1文字書き込む。</td>
<td><code><a href="basic_streambuf/overflow.html">overflow</a></code></td>
<td>出力部分列の領域を消費し切った際の処理 (protected virtual)。</td>
<td><code><a href="basic_streambuf/sputn.html">sputn</a></code></td>
<td>出力列に複数文字を書き込む。</td>
<td><code><a href="basic_streambuf/xsputn.html">xsputn</a></code></td>
<td>出力列に複数文字を書き込む (protected virtual)。</td>
<h3>出力部分列の操作</h3>
<table border="1" bordercolor="#888" style="border-collapse:collapse">
<th>名前</th>
<th>説明</th>
<th>対応バージョン</th>
<td><code><a href="basic_streambuf/pbase.html">pbase</a></code></td>
<td>出力部分列の先頭へのポインタを返す (protected)。</td>
<td><code><a href="basic_streambuf/pptr.html">pptr</a></code></td>
<td>出力部分列の現在位置へのポインタを返す (protected)。</td>
<td><code><a href="basic_streambuf/epptr.html">epptr</a></code></td>
<td>出力部分列の終端へのポインタを返す (protected)。</td>
<td><code><a href="basic_streambuf/pbump.html">pbump</a></code></td>
<td>出力部分列の現在位置を指定した量だけ進める (protected)。</td>
<td><code><a href="basic_streambuf/setp.html">setp</a></code></td>
<td>出力部分列の各ポインタを設定する (protected)。</td>
<h2>参照</h2></div>
      </div>
    <div id="sidebar" class="col-sm-3 col-sm-pull-9">
            </div>
        </main>
<footer class="footer navbar navbar-default">
  <div class="container-fluid">
    <p><small>
      本サイトの情報は、
        <a href="https://creativecommons.org/licenses/by/4.0/deed.ja" rel="nofollow">クリエイティブ・コモンズ 表示 4.0 非移植 ライセンス(CC BY)</a>
      の下に提供されています。
    </small></p>
    </body>
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

basic_streambuf.html

Latest commit

History

basic_streambuf.html

File metadata and controls
