Spec-Zone.ru › C++

std::basic_ifstream

Определено в заголовке <fstream>
template< 
    class CharT, 
    class Traits = std::char_traits<CharT>
> class basic_ifstream : public std::basic_istream<CharT, Traits>

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

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

cpp/io/ios base cpp/io/basic ios cpp/io/basic istreamstd-basic ifstream-inheritance.svg

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

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

Определено в заголовке <fstream>
Тип Определение
std::ifstream std::basic_ifstream<char>
std::wifstream std::basic_ifstream<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

Члены-функции

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

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

std::swap(std::basic_ifstream)
(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_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
определяет тип события
(перечисление)
event_callback
тип обратного вызова функции
(typedef)

Примечания

Макроинструкция проверки наличия функции Значение Std Функция
__cpp_lib_fstream_native_handle 202306L (C++26) поддержка родных дескрипторов

Пример

#include <fstream>
#include <iostream>
#include <string>
 
int main()
{
    std::string filename = "Test.b";
 
    // prepare a file to read
    double d = 3.14;
    std::ofstream(filename, std::ios::binary)
        .write(reinterpret_cast<char*>(&d), sizeof d) << 123 << "abc";
 
    // open file for reading
    std::ifstream istrm(filename, std::ios::binary);
    if (!istrm.is_open())
        std::cout << "failed to open " << filename << '\n';
    else
    {
        double d;
        istrm.read(reinterpret_cast<char*>(&d), sizeof d); // binary input
        int n;
        std::string s;
        if (istrm >> n >> s)                               // text input
            std::cout << "read back from file: " << d << ' ' << n << ' ' << s << '\n';
    }
}

Вывод:

read back from file: 3.14 123 abc

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

Spec-Zone.ru

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