std:: basic_fstream

From cppreference.net

Определено в заголовочном файле `<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 > .

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

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

Определено в заголовочном файле `<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`

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

(constructor)	конструирует файловый поток (public member function)
(destructor) [virtual] (implicitly declared)	уничтожает объект `basic_fstream` и связанный буфер, закрывает файл (virtual public member function)
operator= (C++11)	перемещает файловый поток (public member function)
swap (C++11)	обменивает два файловых потока (public member function)
rdbuf	возвращает базовый объект файлового устройства (public member function)
native_handle (C++26)	возвращает базовый дескриптор, определяемый реализацией (public member function)
Операции с файлами
is_open	проверяет, ассоциирован ли поток с файлом (public member function)
open	открывает файл и ассоциирует его с потоком (public member function)
close	закрывает ассоциированный файл (public member function)

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

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 [static]	возвращает уникальное для программы целое число, безопасное для использования в качестве индекса для `pword()` и `iword()` (публичная статическая функция-член `std::ios_base` )
iword	изменяет размер приватного хранилища при необходимости и предоставляет доступ к long элементу по заданному индексу (публичная функция-член `std::ios_base` )
pword	изменяет размер приватного хранилища при необходимости и предоставляет доступ к void * элементу по заданному индексу (публичная функция-член `std::ios_base` )
Прочее
register_callback	регистрирует функцию обратного вызова событий (публичная функция-член `std::ios_base` )
sync_with_stdio [static]	устанавливает, являются ли библиотеки ввода-вывода C++ и C совместимыми (публичная статическая функция-член `std::ios_base` )
Классы-члены
failure	исключение потока (публичный класс-член `std::ios_base` )
Init	инициализирует объекты стандартных потоков (публичный класс-член `std::ios_base` )

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

Тип Объяснение

openmode

тип режима открытия потока

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

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

(typedef)

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

(typedef)

iostate

тип состояния потока

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

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

(typedef)

seekdir

тип направления позиционирования

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

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

(typedef)

event

определяет тип события
(enum)

event_callback

тип функции обратного вызова
(typedef)

Примечания

Макрос тестирования возможностей	Значение	Стандарт	Возможность
`__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
    {
        // запись
        double d{3.14};
        s.write(reinterpret_cast<char*>(&d), sizeof d); // бинарный вывод
        s << 123 << "abc";                              // текстовый вывод
        // для fstream это перемещает указатель позиции файла (и put, и get)
        s.seekp(0);
        // чтение
        d = 2.71828;
        s.read(reinterpret_cast<char*>(&d), sizeof d); // бинарный ввод
        int n;
        std::string str;
        if (s >> n >> str)                             // текстовый ввод
            std::cout << "read back from file: " << d << ' ' << n << ' ' << str << '\n';
    }
}

Вывод:

read back from file: 3.14 123 abc

Смотрите также

getline

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

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Diagnostics library
Memory management library
Metaprogramming library (C++11)
General utilities library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Strings library
Text processing library
Numerics library
Date and time library
Input/output library
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Technical specifications
Symbols index
External libraries

I/O manipulators
Print functions (C++23)
C-style I/O
Buffers
basic_streambuf
basic_filebuf
basic_stringbuf
basic_spanbuf (C++23)
strstreambuf ( C++98/26* )
basic_syncbuf (C++20)
Streams
Abstractions
ios_base
basic_ios
basic_istream
basic_ostream
basic_iostream
File I/O
basic_ifstream
basic_ofstream
basic_fstream
String I/O
basic_istringstream
basic_ostringstream
basic_stringstream
Array 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* )
Synchronized Output
basic_osyncstream (C++20)
Types
streamoff
streamsize
fpos
Error category interface
iostream_category (C++11)
io_errc (C++11)

Member functions
basic_fstream::basic_fstream
basic_fstream::operator= (C++11)
basic_fstream::swap (C++11)
basic_fstream::rdbuf
basic_fstream::native_handle (C++26)
File operations
basic_fstream::is_open
basic_fstream::open
basic_fstream::close
Non-member functions
swap (std::basic_fstream) (C++11)

cppreference.net

Namespaces

Variants

std:: basic_fstream

Содержание

Типы членов

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

Операции с файлами

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

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

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

Форматированный ввод

Неформатированный ввод

Позиционирование

Прочие функции

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

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

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

Форматированный вывод

Неформатированный вывод

Позиционирование

Прочие функции

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

Наследуется от std:: basic_ios

Типы членов

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

Функции состояния

Форматирование

Прочие

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

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

Форматирование

Локали

Внутренний расширяемый массив

Прочее

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

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

Примечания

Пример

Смотрите также