std::basic_filebuf<CharT,Traits>::setbuf

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

执行支持库 (C++26)

技术规范

符号索引

外部库

 

输入/输出库

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_filebuf

公有成员函数

basic_filebuf::basic_filebuf

basic_filebuf::~basic_filebuf

basic_filebuf::operator= (C++11)

basic_filebuf::swap (C++11)

basic_filebuf::native_handle (C++26)

basic_filebuf::is_open

basic_filebuf::open

basic_filebuf::close

受保护的成员函数

basic_filebuf::showmanyc

basic_filebuf::underflow

basic_filebuf::uflow

basic_filebuf::pbackfail

basic_filebuf::overflow

basic_filebuf::setbuf

basic_filebuf::seekoff

basic_filebuf::seekpos

basic_filebuf::sync

basic_filebuf::imbue

非成员函数

swap(std::basic_filebuf) (C++11)

 

protected: virtual std::basic_streambuf<CharT, Traits>* setbuf( char_type* s, std::streamsize n )

如果 s 是一个空指针，并且 n 是零，则 filebuf 将为输出变为非缓冲，这意味着 pbase() 和 pptr() 为空，并且任何输出都会立即发送到文件。

否则，调用 setbuf() 会将内部缓冲区（受控字符序列）替换为用户提供的字符数组，该数组的第一个元素由 s 指向，并允许此 std::basic_filebuf 对象使用该数组中的最多 n 个字节进行缓冲。

此函数为受保护的虚函数，只能通过 pubsetbuf() 或从派生自 std::basic_filebuf 的用户定义类的成员函数中调用。

参数

s	-	指向用户提供缓冲区中的第一个 CharT 的指针或空指针
n	-	用户提供缓冲区中的 CharT 元素数或零

返回值

this

注意事项

此函数可使用的情况以及提供缓冲区的使用方式是实现定义的。

• GCC 4.6 libstdc++

setbuf() 只能在 std::basic_filebuf 未与文件关联（无任何影响）时调用。使用用户提供的缓冲区时，从文件读取每次读取 n-1 个字节。

• Clang++3.0 libc++

setbuf() 可以在打开文件后但任何 I/O 之前调用（否则可能会崩溃）。使用用户提供的缓冲区时，从文件读取每次读取适合缓冲区的 4096 的最大倍数。

• Visual Studio 2010

setbuf() 可以在任何时间调用，即使在一些 I/O 完成之后。缓冲区中的当前内容（如果有）将丢失。

标准未定义此函数的任何行为，但要求在任何 I/O 完成之前调用 setbuf(0, 0) 设置无缓冲输出。

示例

为读取提供 10k 缓冲区。在 Linux 上，可以使用 strace 实用程序观察实际读取的字节数。

运行此代码

#include <fstream>
#include <iostream>
#include <string>
 
int main()
{
    int cnt = 0;
    std::ifstream file;
    char buf[10241];
 
    file.rdbuf()->pubsetbuf(buf, sizeof buf);
    file.open("/usr/share/dict/words");
 
    for (std::string line; getline(file, line);)
        ++cnt;
    std::cout << cnt << '\n';
}

可能的输出

356010

缺陷报告

以下更改行为的缺陷报告被追溯地应用于以前发布的 C++ 标准。

DR	应用于	已发布的行为	正确行为
LWG 173	C++98	n 的类型被错误地指定为 int	更正为 std::streamsize

参见

pubsetbuf	调用 setbuf() (std::basic_streambuf<CharT,Traits> 的公有成员函数)
setvbuf	为文件流设置缓冲区及其大小 (函数)