std::setvbuf

来自cppreference.com
< cpp | io | c
 
C++
 
输入/输出库
 
C 风格 I/O
 
在标头 <cstdio> 定义 
int setvbuf( std::FILE* stream, char* buffer, int mode, std::size_t size );

以 mode 所指示值更改给定文件流 stream 的缓冲模式。另外，

  • 若 buffer 为空指针，则重设内部缓冲区大小为 size。
  • 若 buffer 不是空指针，则指示流使用始于 buffer 大小为 size 的用户提供缓冲区。必须在 buffer 所指向的数组的生存期结束前（用 fclose）关闭流。成功调用 std::setvbuf 后，数组内容不确定，而任何使用它的尝试是未定义行为。

参数

stream - 要设置缓冲的文件流
buffer - 指向要使用的流缓冲区的指针，或若仅更改大小和模式则为空指针
mode - 使用的缓冲模式。它可为下列值之一：
_IOFBF 全缓冲：当缓冲区为空时，从流读入数据。或者当缓冲区满时，向流写入数据。
_IOLBF 行缓冲：每次从流中读入一行数据或向流中写入一行数据。
_IONBF 无缓冲：直接从流中读入数据或直接向流中写入数据，缓冲设置无效。
size - 缓冲区的大小

返回值

成功时为 0，失败时为非零。

注解

此函数仅可在已将 stream 关联到打开的文件后，但要在任何其他操作（除了对 std::setbuf/std::setvbuf 的失败调用）前使用。

不是所有 size 字节都需要用于缓冲：实际缓冲区大小通常向下取整到 2 的倍数、页面大小的倍数等。

多数实现上，行缓冲仅对终端输入流可用。

一个常见错误是把 stdin 或 stdout 的缓冲区设置为生存期在程序终止前结束的数组： 

int main()
{
    char buf[BUFSIZ];
    std::setbuf(stdin, buf);
} // buf 的生存期结束，未定义行为

期待默认缓冲区大小 BUFSIZ 为实现上文件 I/O 的最高效缓冲区大小，但 POSIX fstat 经常提供更好的估计。

示例

更改缓冲区大小的一个使用情况，是在知道更好的缓冲区大小时。

运行此代码
#include <cstdio>
#include <cstdlib>
#include <iostream>
#include <sys/stat.h>

int main()
{
    std::FILE* fp = std::fopen("/tmp/test.txt", "w+");
    if (!fp)
    {
        std::perror("fopen");
        return EXIT_FAILURE;
    }

    struct stat stats;
    if (fstat(fileno(fp), &stats) == -1) // 仅限 POSIX
    {
        std::perror("fstat");
        return EXIT_FAILURE;
    }

    std::cout << "BUFSIZ 为 " << BUFSIZ << "，但最优块大小为 "
              << stats.st_blksize << '\n';
    if (std::setvbuf(fp, nullptr, _IOFBF, stats.st_blksize) != 0)
    {
        std::perror("setvbuf failed"); // POSIX 版本设置 errno
        return EXIT_FAILURE;
    }

    // 读取整个文件：用 truss/strace 观察所用的 read(2) 系统调用
    for (int ch; (ch = std::fgetc(fp)) != EOF;)
    {}

    std::fclose(fp);
    return EXIT_SUCCESS;
}

可能的输出： 

BUFSIZ 为 8192，但最优块大小为 65536

参阅

 为文件流设置缓冲区
(函数)
[虚]
 提供用户供应的缓冲区，或将此 filebuf 转变为无缓冲
(std::basic_filebuf<CharT,Traits> 的虚受保护成员函数)
setvbuf 的 C 文档