Spec-Zone.ru › C++

std::basic_fstream

Определён в заголовочном файле <fstream>
template<
    class CharT,
    class Traits = std::char_traits<CharT>
> class basic_fstream : public std::basic_iostream<CharT, Traits>

Шаблон класса basic_fstream реализует высокоуровневые операции ввода-вывода для потоков, основанных на файлах. Он связывает файловый буфер потока (std::basic_filebuf) с высокоуровневым интерфейсом (std::basic_iostream).

Типичная реализация std::basic_fstream содержит только один нестатический член данных, не являющийся базовым классом: экземпляр std::basic_filebuf<CharT,Traits>.

cpp/io/ios base cpp/io/basic ios cpp/io/basic istream cpp/io/basic ostream cpp/io/basic iostream

Диаграмма наследования

Предоставляется несколько псевдонимов типов для распространённых типов символов:

Определён в заголовочном файле <fstream>
Тип Определение
std::fstream std::basic_fstream<char>
std::wfstream std::basic_fstream<wchar_t>

Типы-члены

Тип-член Определение
char_type CharT
traits_type Traits; программа некорректна, если Traits::char_type не является CharT.
int_type Traits::int_type
pos_type Traits::pos_type
off_type Traits::off_type
native_handle_type(C++26) тип, определяемый реализацией, который является TriviallyCopyable и semiregular

Функции-члены

(конструктор)
создаёт файловый поток
(открытая функция-член)
(деструктор)
[виртуальная] (объявлена неявно)
уничтожает basic_fstream и связанный буфер, закрывает файл
(виртуальная открытая функция-член)
operator=
(C++11)
перемещает файловый поток
(открытая функция-член)
swap
(C++11)
обменивает местами два файловых потока
(открытая функция-член)
rdbuf
возвращает объект нижележащего файлового устройства
(открытая функция-член)
native_handle
(C++26)
возвращает дескриптор, определяемый реализацией
(открытая функция-член)
Операции с файлами
is_open
проверяет, связан ли с потоком файл
(открытая функция-член)
open
открывает файл и связывает его с потоком
(открытая функция-член)
close
закрывает связанный файл
(открытая функция-член)

Функции, не являющиеся членами

std::swap(std::basic_fstream)
(C++11)
специализирует алгоритм std::swap
(шаблон функции)

Унаследовано от std::basic_istream

Функции-члены

Форматированный ввод
operator>>
извлекает форматированные данные
(открытая функция-член std::basic_istream<CharT,Traits>)
Неформатированный ввод
get
извлекает символы
(открытая функция-член std::basic_istream<CharT,Traits>)
peek
читает следующий символ, не извлекая его
(открытая функция-член std::basic_istream<CharT,Traits>)
unget
возвращает символ во входной поток
(открытая функция-член std::basic_istream<CharT,Traits>)
putback
помещает символ во входной поток
(открытая функция-член std::basic_istream<CharT,Traits>)
getline
извлекает символы до обнаружения заданного символа
(открытая функция-член std::basic_istream<CharT,Traits>)
ignore
извлекает и отбрасывает символы до обнаружения заданного символа
(открытая функция-член std::basic_istream<CharT,Traits>)
read
извлекает блоки символов
(открытая функция-член std::basic_istream<CharT,Traits>)
readsome
извлекает уже доступные блоки символов
(открытая функция-член std::basic_istream<CharT,Traits>)
gcount
возвращает количество символов, извлечённых последней операцией неформатированного ввода
(открытая функция-член std::basic_istream<CharT,Traits>)
Позиционирование
tellg
возвращает указатель позиции ввода
(открытая функция-член std::basic_istream<CharT,Traits>)
seekg
устанавливает указатель позиции ввода
(открытая функция-член std::basic_istream<CharT,Traits>)
Разное
sync
синхронизируется с нижележащим устройством хранения данных
(открытая функция-член std::basic_istream<CharT,Traits>)

Классы-члены

sentry
реализует базовую логику подготовки потока к операциям ввода
(открытый класс-член std::basic_istream<CharT,Traits>)

Унаследовано от std::basic_ostream

Функции-члены

Форматированный вывод
operator<<
вставляет форматированные данные
(открытая функция-член std::basic_ostream<CharT,Traits>)
Неформатированный вывод
put
вставляет символ
(открытая функция-член std::basic_ostream<CharT,Traits>)
write
вставляет блоки символов
(открытая функция-член std::basic_ostream<CharT,Traits>)
Позиционирование
tellp
возвращает указатель позиции вывода
(открытая функция-член std::basic_ostream<CharT,Traits>)
seekp
устанавливает указатель позиции вывода
(открытая функция-член std::basic_ostream<CharT,Traits>)
Разное
flush
синхронизируется с нижележащим устройством хранения данных
(открытая функция-член std::basic_ostream<CharT,Traits>)

Классы-члены

sentry
реализует базовую логику подготовки потока к операциям вывода
(открытый класс-член std::basic_ostream<CharT,Traits>)

Унаследовано от std::basic_ios

Типы-члены

Тип-член Определение
char_type CharT
traits_type Traits
int_type Traits::int_type
pos_type Traits::pos_type
off_type Traits::off_type

Функции-члены

Функции состояния
good
проверяет, не произошла ли ошибка, то есть доступны ли операции ввода-вывода
(открытая функция-член std::basic_ios<CharT,Traits>)
eof
проверяет, достигнут ли конец файла
(открытая функция-член std::basic_ios<CharT,Traits>)
fail
проверяет, произошла ли ошибка
(открытая функция-член std::basic_ios<CharT,Traits>)
bad
проверяет, произошла ли неустранимая ошибка
(открытая функция-член std::basic_ios<CharT,Traits>)
operator!
проверяет, произошла ли ошибка (синоним fail())
(открытая функция-член std::basic_ios<CharT,Traits>)
operator bool
проверяет, не произошла ли ошибка (синоним !fail())
(открытая функция-член std::basic_ios<CharT,Traits>)
rdstate
возвращает флаги состояния
(открытая функция-член std::basic_ios<CharT,Traits>)
setstate
устанавливает флаги состояния
(открытая функция-член std::basic_ios<CharT,Traits>)
clear
изменяет флаги состояния
(открытая функция-член std::basic_ios<CharT,Traits>)
Форматирование
copyfmt
копирует сведения о форматировании
(открытая функция-член std::basic_ios<CharT,Traits>)
fill
управляет символом заполнения
(открытая функция-член std::basic_ios<CharT,Traits>)
Разное
exceptions
управляет маской исключений
(открытая функция-член std::basic_ios<CharT,Traits>)
imbue
устанавливает локаль
(открытая функция-член std::basic_ios<CharT,Traits>)
rdbuf
управляет связанным буфером потока
(открытая функция-член std::basic_ios<CharT,Traits>)
tie
управляет связанным потоком
(открытая функция-член std::basic_ios<CharT,Traits>)
narrow
преобразует символы в узкие символы
(открытая функция-член std::basic_ios<CharT,Traits>)
widen
преобразует символы в широкие символы
(открытая функция-член std::basic_ios<CharT,Traits>)

Унаследовано от std::ios_base

Функции-члены

Форматирование
flags
управляет флагами форматирования
(открытая функция-член std::ios_base)
setf
устанавливает заданный флаг форматирования
(открытая функция-член std::ios_base)
unsetf
сбрасывает заданный флаг форматирования
(открытая функция-член std::ios_base)
precision
управляет десятичной точностью операций с числами с плавающей точкой
(открытая функция-член std::ios_base)
width
управляет шириной поля
(открытая функция-член std::ios_base)
Локали
imbue
устанавливает локаль
(открытая функция-член std::ios_base)
getloc
возвращает текущую локаль
(открытая функция-член std::ios_base)
Внутренний расширяемый массив
xalloc
[статическая]
возвращает уникальное для всей программы целое число, которое можно безопасно использовать в качестве индекса для pword() и iword()
(открытая статическая функция-член std::ios_base)
iword
при необходимости увеличивает размер приватного хранилища и предоставляет доступ к элементу типа long с заданным индексом
(открытая функция-член std::ios_base)
pword
при необходимости увеличивает размер приватного хранилища и предоставляет доступ к элементу типа void* с заданным индексом
(открытая функция-член std::ios_base)
Разное
register_callback
регистрирует функцию обратного вызова события
(открытая функция-член std::ios_base)
sync_with_stdio
[статическая]
задаёт, могут ли библиотеки ввода-вывода C++ и C взаимодействовать друг с другом
(открытая статическая функция-член std::ios_base)
Классы-члены
failure
исключение потока
(открытый класс-член std::ios_base)
Init
инициализирует стандартные объекты потоков
(открытый класс-член std::ios_base)

Типы и константы-члены

Тип Пояснение
openmode
тип режима открытия потока

Также определены следующие константы:

Константа Пояснение
app перед каждой записью переходить в конец потока
binary открыть в двоичном режиме
in открыть для чтения
out открыть для записи
trunc при открытии удалить содержимое потока
ate сразу после открытия перейти в конец потока
noreplace (C++23) открыть в эксклюзивном режиме

(псевдоним типа)
fmtflags
тип флагов форматирования

Также определены следующие константы:

Константа Пояснение
dec использовать десятичную систему счисления для целочисленного ввода-вывода: см. std::dec
oct использовать восьмеричную систему счисления для целочисленного ввода-вывода: см. std::oct
hex использовать шестнадцатеричную систему счисления для целочисленного ввода-вывода: см. std::hex
basefield dec | oct | hex. Полезно для операций маскирования
left выравнивание по левому краю (добавляет символы заполнения справа): см. std::left
right выравнивание по правому краю (добавляет символы заполнения слева): см. std::right
internal внутреннее выравнивание (добавляет символы заполнения в заданную внутреннюю позицию): см. std::internal
adjustfield left | right | internal. Полезно для операций маскирования
scientific выводить числа с плавающей точкой в научной нотации или в шестнадцатеричной нотации в сочетании с fixed: см. std::scientific
fixed выводить числа с плавающей точкой в фиксированной нотации или в шестнадцатеричной нотации в сочетании с scientific: см. std::fixed
floatfield scientific | fixed. Полезно для операций маскирования
boolalpha вставлять и извлекать значения типа bool в алфавитно-цифровом формате: см. std::boolalpha
showbase выводить префикс, указывающий систему счисления для целочисленных значений, и требовать обозначение валюты при денежном вводе-выводе: см. std::showbase
showpoint всегда выводить десятичный разделитель при выводе чисел с плавающей точкой: см. std::showpoint
showpos выводить символ + для неотрицательных чисел: см. std::showpos
skipws пропускать начальные пробельные символы перед некоторыми операциями ввода: см. std::skipws
unitbuf сбрасывать буфер вывода после каждой операции вывода: см. std::unitbuf
uppercase заменять некоторые строчные буквы их прописными эквивалентами при выполнении некоторых операций вывода: см. std::uppercase

(псевдоним типа)
iostate
тип состояния потока

Также определены следующие константы:

Константа Пояснение
goodbit ошибок нет
badbit неустранимая ошибка потока
failbit ошибка операции ввода-вывода (ошибка форматирования или извлечения)
eofbit связанная последовательность ввода достигла конца файла

(псевдоним типа)
seekdir
тип направления перемещения

Также определены следующие константы:

Константа Пояснение
beg начало потока
end конец потока
cur текущая позиция указателя позиции потока

(псевдоним типа)
event
задаёт тип события
(перечисление)
event_callback
тип функции обратного вызова
(псевдоним типа)

Примечания

Макрос проверки поддержки возможностей Значение Стандарт Возможность
__cpp_lib_fstream_native_handle 202306L (C++26) поддержка нативных дескрипторов

Пример

#include <fstream>
#include <iostream>
#include <string>

int main()
{
    std::string filename{"test.bin"};
    std::fstream s{filename, s.binary | s.trunc | s.in | s.out};

    if (!s.is_open())
        std::cout << "failed to open " << filename << '\n';
    else
    {
        // write
        double d{3.14};
        s.write(reinterpret_cast<char*>(&d), sizeof d); // binary output
        s << 123 << "abc";                              // text output
        
        // for fstream, this moves the file position pointer (both put and get)
        s.seekp(0);
        
        // read
        d = 2.71828;
        s.read(reinterpret_cast<char*>(&d), sizeof d); // binary input
        int n;
        std::string str;
        if (s >> n >> str)                             // text input
            std::cout << "read back from file: " << d << ' ' << n << ' ' << str << '\n';
    }
}

Вывод:

read back from file: 3.14 123 abc

См. также

getline
считывает данные из потока ввода-вывода в строку
(шаблон функции)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/io/basic_fstream

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API