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 iostream

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

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

Определено в заголовочном файле <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 (закрытый) Обёрнутый std::basic_spanbuf.
(объект-член, существующий только для описания)

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

(конструктор)
создаёт basic_spanstream
(открытая функция-член)
(деструктор)
[виртуальный]
уничтожает basic_spanstream
(виртуальная открытая функция-член)
operator=
выполняет перемещающее присваивание для basic_spanstream
(открытая функция-член)
swap
обменивает местами два объекта basic_spanstream
(открытая функция-член)
rdbuf
получает адрес обёрнутого объекта низкоуровневого устройства span
(открытая функция-член)
Операции с базовым буфером
span
получает или задаёт базовый буфер обёрнутого объекта устройства 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>)

Унаследовано от 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_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/cpp/io/basic_spanstream

Spec-Zone.ru

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