Spec-Zone.ru › C++

std::basic_spanstream

Определено в заголовке <spanstream>
template<
    class CharT,
    class Traits = std::char_traits<CharT>
> class basic_spanstream
    : public basic_iostream<CharT, Traits>
(с C++23)

Шаблон класса std::basic_spanstream реализует операции ввода и вывода для потоков, основанных на фиксированных буферах.

На низком уровне класс по существу оборачивает реализацию базового устройства std::basic_spanbuf в интерфейс более высокого уровня std::basic_iostream. Предоставляется полный интерфейс к уникальным членам std::basic_spanbuf.

cpp/io/ios base cpp/io/basic ios cpp/io/basic istream cpp/io/basic ostream cpp/io/basic iostreamstd-basic spanstream-inheritance.svg

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

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

Определено в заголовке <spanstream>
Тип Определение
std::spanstream std::basic_spanstream<char>
std::wspanstream std::basic_spanstream<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

Члены данных

Имя члена Определение
sb (private) Оборачиваемое std::basic_spanbuf.
(только для иллюстрации*)

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

(конструктор)
(C++23)
создаёт basic_spanstream
(публичный член-функция)
(деструктор)
[virtual] (C++23)
уничтожает basic_spanstream
(виртуальная публичная член-функция)
operator=
(C++23)
выполняет присваивание по значению для basic_spanstream
(публичный член-функция)
swap
(C++23)
меняет местами два объекта basic_spanstream
(публичный член-функция)
rdbuf
(C++23)
получает адрес обернутого необработанного устройства span
(публичный член-функция)
Операции с базовым буфером
span
(C++23)
получает или задаёт базовый буфер обернутого span устройства
(публичный член-функция)

Независимые функции

std::swap(std::basic_spanstream)
(C++23)
специализирует алгоритм 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>)
END_OF_DOCUMENT_MARKER

Унаследовано от 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>)
END_OF_DOCUMENT_MARKER

Унаследованно от 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) Открытие в эксклюзивном режиме

(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)

Примечания

Макрос проверки наличия функции Значение Std Функция
__cpp_lib_spanstream 202106L (C++23) std::spanbuf, std::spanstream

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

Spec-Zone.ru

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