Spec-Zone.ru › C++

std::basic_ispanstream

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

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

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

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

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

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

Определено в заголовке <spanstream>
Тип Определение
std::ispanstream std::basic_ispanstream<char>
std::wispanstream std::basic_ispanstream<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_ispanstream
(публичный член-функция)
(деструктор)
[virtual] (C++23)
уничтожает basic_ispanstream
(виртуальная публичная член-функция)
operator=
(C++23)
выполняет присваивание по ссылке basic_ispanstream
(публичный член-функция)
swap
(C++23)
обменивает двумя basic_ispanstream объектами
(публичный член-функция)
rdbuf
(C++23)
получает адрес обернутого сырого span устройства
(публичный член-функция)
Операции с базовым буфером
span
(C++23)
получает или устанавливает базовый буфер обернутого span устройства
(публичный член-функция)

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

std::swap(std::basic_ispanstream)
(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_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)
END_OF_DOCUMENT_MARKER

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

Тип Объяснение
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)

Примечания

Макрокоманда проверки наличия функции Значение Стандарт Функция
__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_ispanstream

Spec-Zone.ru

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