命名空间
变体
操作

std::setvbuf

来自 cppreference.com
< cpp‎ | io‎ | c
 
 
 
 
定义在头文件 <cstdio>
int setvbuf( std::FILE* stream, char* buffer, int mode, std::size_t size );

根据参数 mode 更改给定文件流 stream 的缓冲模式。此外,

  • 如果 buffer 是一个空指针,将内部缓冲区的大小调整为 size
  • 如果 buffer 不是一个空指针,则指示流使用以 buffer 开头的用户提供的缓冲区,大小为 size。在 buffer 所指向的数组的生命周期结束之前,必须关闭流(使用 std::fclose)。成功调用 std::setvbuf 后,数组的内容是不确定的,任何尝试使用它都是未定义的行为。

内容

[编辑] 参数

stream - 要设置缓冲区的文件流
buffer - 指向流要使用的缓冲区的指针,或者空指针仅更改大小和模式
mode - 要使用的缓冲模式。它可以是以下值之一
_IOFBF 完全缓冲
_IOLBF 行缓冲
_IONBF 无缓冲
size - 缓冲区的大小

[编辑] 返回值

成功时返回 0,失败时返回非零值。

[编辑] 说明

此函数只能在 stream 与打开的文件关联之后,但在执行任何其他操作(除了对 std::setbuf/std::setvbuf 的失败调用)之前使用。

并非所有 size 字节都会被用于缓冲:实际的缓冲区大小通常会向下舍入为 2 的倍数、页面大小的倍数等等。

在许多实现中,行缓冲仅适用于终端输入流。

一个常见的错误是将 stdinstdout 的缓冲区设置为在程序终止之前结束生命周期的数组。

int main()
{
    char buf[BUFSIZ];
    std::setbuf(stdin, buf);
} // lifetime of buf ends, undefined behavior

默认缓冲区大小 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 only
    {
        std::perror("fstat");
        return EXIT_FAILURE;
    }
 
    std::cout << "BUFSIZ is " << BUFSIZ << ", but optimal block size is "
              << stats.st_blksize << '\n';
    if (std::setvbuf(fp, nullptr, _IOFBF, stats.st_blksize) != 0)
    {
        std::perror("setvbuf failed"); // POSIX version sets errno
        return EXIT_FAILURE;
    }
 
    // Read entire file: use truss/strace to observe the read(2) syscalls used
    for (int ch; (ch = std::fgetc(fp)) != EOF;)
    {}
 
    std::fclose(fp);
    return EXIT_SUCCESS;
}

可能的输出

BUFSIZ is 8192, but optimal block size is 65536

[编辑] 另请参阅

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