std:: basic_ispanstream
From cppreference.com
|
Defined in header
<spanstream>
|
||
|
template
<
class
CharT,
|
(since C++23) | |
The class template
std::basic_ispanstream
implements input operations on streams based on fixed buffers.
At the low level, the class essentially wraps a raw device implementation of std::basic_spanbuf into a higher-level interface of std::basic_istream . The complete interface to unique std::basic_spanbuf members is provided.
Inheritance diagram
Several typedefs for common character types are provided:
|
Defined in header
<spanstream>
|
|
| Type | Definition |
std::ispanstream
|
std :: basic_ispanstream < char > |
std::wispanstream
|
std :: basic_ispanstream < wchar_t > |
Member types
| Member type | Definition |
char_type
|
CharT
|
traits_type
|
Traits
; the program is ill-formed if
Traits::char_type
is not
CharT
.
|
int_type
|
Traits::int_type
|
pos_type
|
Traits::pos_type
|
off_type
|
Traits::off_type
|
Data members
| Member object | Definition |
sb
(private)
|
The wrapped
std::basic_spanbuf
.
( exposition-only member object* ) |
Member functions
constructs the
basic_ispanstream
(public member function) |
|
|
(destructor)
[virtual]
|
destroys the
basic_ispanstream
(virtual public member function) |
move-assignments the
basic_ispanstream
(public member function) |
|
swaps two
basic_ispanstream
objects
(public member function) |
|
obtains the address of the wrapped raw
span
device object
(public member function) |
|
Underlying buffer operations |
|
gets or sets the underlying buffer of the wrapped
span
device object
(public member function) |
|
Non-member functions
|
specializes the
std::swap
algorithm
(function template) |
Inherited from std:: basic_istream
Member functions
Formatted input |
|
|
extracts formatted data
(public member function of
std::basic_istream<CharT,Traits>
)
|
|
Unformatted input |
|
|
extracts characters
(public member function of
std::basic_istream<CharT,Traits>
)
|
|
|
reads the next character without extracting it
(public member function of
std::basic_istream<CharT,Traits>
)
|
|
|
unextracts a character
(public member function of
std::basic_istream<CharT,Traits>
)
|
|
|
puts a character into input stream
(public member function of
std::basic_istream<CharT,Traits>
)
|
|
|
extracts characters until the given character is found
(public member function of
std::basic_istream<CharT,Traits>
)
|
|
|
extracts and discards characters until the given character is found
(public member function of
std::basic_istream<CharT,Traits>
)
|
|
|
extracts blocks of characters
(public member function of
std::basic_istream<CharT,Traits>
)
|
|
|
extracts already available blocks of characters
(public member function of
std::basic_istream<CharT,Traits>
)
|
|
|
returns number of characters extracted by last unformatted input operation
(public member function of
std::basic_istream<CharT,Traits>
)
|
|
Positioning |
|
|
returns the input position indicator
(public member function of
std::basic_istream<CharT,Traits>
)
|
|
|
sets the input position indicator
(public member function of
std::basic_istream<CharT,Traits>
)
|
|
Miscellaneous |
|
|
synchronizes with the underlying storage device
(public member function of
std::basic_istream<CharT,Traits>
)
|
|
Member classes
|
implements basic logic for preparation of the stream for input operations
(public member class of
std::basic_istream<CharT,Traits>
)
|
Inherited from std:: basic_ios
Member types
| Member type | Definition |
char_type
|
CharT
|
traits_type
|
Traits
|
int_type
|
Traits::int_type
|
pos_type
|
Traits::pos_type
|
off_type
|
Traits::off_type
|
Member functions
State functions |
|
|
checks if no error has occurred i.e. I/O operations are available
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
|
checks if end-of-file has been reached
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
|
checks if an error has occurred
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
|
checks if a non-recoverable error has occurred
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
|
checks if an error has occurred (synonym of
fail()
)
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
checks if no error has occurred (synonym of
!
fail()
)
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
|
returns state flags
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
|
sets state flags
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
|
modifies state flags
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
Formatting |
|
|
copies formatting information
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
|
manages the fill character
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
Miscellaneous |
|
|
manages exception mask
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
|
sets the locale
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
|
manages associated stream buffer
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
|
manages tied stream
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
|
narrows characters
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
|
widens characters
(public member function of
std::basic_ios<CharT,Traits>
)
|
|
Inherited from std:: ios_base
Member functions
Formatting |
|
|
manages format flags
(public member function of
std::ios_base
)
|
|
|
sets specific format flag
(public member function of
std::ios_base
)
|
|
|
clears specific format flag
(public member function of
std::ios_base
)
|
|
|
manages decimal precision of floating point operations
(public member function of
std::ios_base
)
|
|
|
manages field width
(public member function of
std::ios_base
)
|
|
Locales |
|
|
sets locale
(public member function of
std::ios_base
)
|
|
|
returns current locale
(public member function of
std::ios_base
)
|
|
Internal extensible array |
|
|
[static]
|
returns a program-wide unique integer that is safe to use as index to
pword()
and
iword()
(public static member function of
std::ios_base
)
|
|
resizes the private storage if necessary and access to the
long
element at the given index
(public member function of
std::ios_base
)
|
|
|
resizes the private storage if necessary and access to the
void
*
element at the given index
(public member function of
std::ios_base
)
|
|
Miscellaneous |
|
|
registers event callback function
(public member function of
std::ios_base
)
|
|
|
[static]
|
sets whether C++ and C I/O libraries are interoperable
(public static member function of
std::ios_base
)
|
Member classes |
|
|
stream exception
(public member class of
std::ios_base
)
|
|
|
initializes standard stream objects
(public member class of
std::ios_base
)
|
|
Member types and constants |
|||||||||||||||||||||||||||||||||||||||
| Type | Explanation | ||||||||||||||||||||||||||||||||||||||
|
stream open mode type
The following constants are also defined:
(typedef) |
|||||||||||||||||||||||||||||||||||||||
|
formatting flags type
The following constants are also defined:
(typedef) |
|||||||||||||||||||||||||||||||||||||||
|
state of the stream type
The following constants are also defined:
(typedef) |
|||||||||||||||||||||||||||||||||||||||
|
seeking direction type
The following constants are also defined:
(typedef) |
|||||||||||||||||||||||||||||||||||||||
|
specifies event type
(enum) |
|||||||||||||||||||||||||||||||||||||||
|
callback function type
(typedef) |
|||||||||||||||||||||||||||||||||||||||
Notes
| Feature-test macro | Value | Std | Feature |
|---|---|---|---|
__cpp_lib_spanstream
|
202106L | (C++23) | std::spanbuf , std::spanstream |