Spec-Zone.ru › C++

std::basic_ofstream

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

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

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

cpp/io/ios base cpp/io/basic ios cpp/io/basic ostream

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

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

Определён в заголовке <fstream>
Тип Определение
std::ofstream std::basic_ofstream<char>
std::wofstream std::basic_ofstream<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_ofstream и связанный буфер, закрывает файл
(виртуальная открытая функция-член)
operator=
(C++11)
перемещает файловый поток
(открытая функция-член)
swap
(C++11)
обменивает местами два файловых потока
(открытая функция-член)
rdbuf
возвращает объект базового низкоуровневого файлового устройства
(открытая функция-член)
native_handle
(C++26)
возвращает дескриптор, определяемый реализацией
(открытая функция-член)
Операции с файлами
is_open
проверяет, связан ли с потоком файл
(открытая функция-член)
open
открывает файл и связывает его с потоком
(открытая функция-член)
close
закрывает связанный файл
(открытая функция-член)

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

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

Унаследовано от 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.b";
    {
        std::ofstream ostrm(filename, std::ios::binary);
        double d = 3.14;
        ostrm.write(reinterpret_cast<char*>(&d), sizeof d); // binary output
        ostrm << 123 << "abc" << '\n';                      // text output
    }
    
    // read back
    std::ifstream istrm(filename, std::ios::binary);
    double d;
    istrm.read(reinterpret_cast<char*>(&d), sizeof d);
    int n;
    std::string s;
    istrm >> n >> s;
    std::cout << " read back: " << d << ' ' << n << ' ' << s << '\n';
}

Вывод:

read back: 3.14 123 abc

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

Spec-Zone.ru

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