std::basic_istringstream

From Cppreference

< cpp | io
Jump to: navigation, search
C++ Standard Library
Input/output library
I/O manipulators
C-style I/O
Buffers
basic_streambuf
basic_filebuf
basic_stringbuf
strstreambuf (deprecated)
Streams
Abstractions
ios_base
basic_ios
basic_istream
basic_ostream
basic_iostream
File I/O
basic_ifstream
basic_ofstream
basic_fstream
String I/O
basic_istringstream
basic_ostringstream
basic_stringstream
Array I/O
istrstream (deprecated)
ostrstream (deprecated)
strstream (deprecated)
Types
streamoff
streamsize
fpos
Error category interface
iostream_category (C++11)
io_errc (C++11)
std::basic_istringstream
Defined in header <sstream>

template<

    class CharT,
    class Traits = std::char_traits<CharT>

> class basic_istringstream;
 (until C++11)
template<

    class CharT,
    class Traits = std::char_traits<CharT>,
    class Allocator = std::allocator<CharT>

> class basic_istringstream;
 (since C++11)

The class template basic_istringstream implements input operations on memory (std::basic_string) based streams. It essentially wraps a raw string device implementation (basic_stringbuf) into a higher-level interface (basic_istream). The complete interface to unique basic_stringbuf members is provided.

cpp/io/ios base cpp/io/basic ios cpp/io/basic istreamstd-basic istringstream-inheritance.png
About this image

Inheritance diagram

Two specializations for common character types are also defined:

Defined in header <sstream>
Type Definition
istringstream basic_istringstream<char>
wistringstream basic_istringstream<wchar_t>

Contents

[edit] 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
allocator_type Allocator (since C++11)

[edit] Member functions

constructs the string stream
(public member function)
(C++11)
 moves the string stream
(public member function)
(C++11)
 swaps two string streams
(public member function)
returns the underlying raw string device object
(public member function)
String operations
gets or sets the contents of underlying string device object
(public member function)

Inherited from std::basic_istream

Member functions

Formatted input
extracts formatted data
(public member function of std::basic_istream)
Unformatted input
extracts characters
(public member function of std::basic_istream)
reads the next character without extracting it
(public member function of std::basic_istream)
unextracts a character
(public member function of std::basic_istream)
puts character into input stream
(public member function of std::basic_istream)
extracts characters until the given character is found
(public member function of std::basic_istream)
extracts and discards characters until the given character is found
(public member function of std::basic_istream)
extracts blocks of characters
(public member function of std::basic_istream)
extracts already available blocks of characters
(public member function of std::basic_istream)
returns number of characters extracted by last unformatted input operation
(public member function of std::basic_istream)
Positioning
returns the input position indicator
(public member function of std::basic_istream)
sets the input position indicator
(public member function of std::basic_istream)
Miscellaneous
synchronizes with the underlying storage device
(public member function of std::basic_istream)

Member classes

implements basic logic for preparation of the stream for input operations
(public member class of std::basic_istream)


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
State functions
checks if no error has occurred i.e. I/O operations are available
(public member function of std::basic_ios)
checks if end-of-file has been reached
(public member function of std::basic_ios)
checks if a recoverable error has occurred
(public member function of std::basic_ios)
checks if a non-recoverable error has occurred
(public member function of std::basic_ios)
checks if an error has occurred (synonym of fail())
(public member function of std::basic_ios)
(until C++11)
(since C++11)
checks if no error has occurred (synonym of !fail())
(public member function of std::basic_ios)
returns state flags
(public member function of std::basic_ios)
sets state flags
(public member function of std::basic_ios)
clears error and eof flags
(public member function of std::basic_ios)
Formatting
copies formatting information
(public member function of std::basic_ios)
manages the fill character
(public member function of std::basic_ios)
Miscellaneous
manages exception mask
(public member function of std::basic_ios)
sets the locale
(public member function of std::basic_ios)
manages associated stream buffer
(public member function of std::basic_ios)
manages tied stream
(public member function of std::basic_ios)
narrows characters
(public member function of std::basic_ios)
widens characters
(public member function of std::basic_ios)

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 an unique index to be used to access elements in the internal extensible array
(public static member function of std::ios_base)
accesses specified element in the internal extensible array of long elements
(public member function of std::ios_base)
accesses specified element in the internal extensible array of void* elements
(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 IO 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:

Constant Explanation
app seek to the end of stream before each write
binary open in binary mode
in open for reading
out open for writing
trunc discard the contents of the stream when opening
ate seek to the end of stream immediately after open

(typedef)
formatting flags type

The following constants are also defined:

Constant Explanation
dec use decimal base for integer I/O
oct use octal base for integer I/O
hex use hexadecimal base for integer I/O
basefield dec|oct|hex|0. Useful for masking operations
left left adjustment (adds fill characters to the right)
right right adjustment (adds fill characters to the left)
internal internal adjustment (adds fill characters to the internal designated point)
adjustfield left|right|internal. Useful for masking operations
scientific generate floating point types using scientific notation, or hex notation if combined with fixed
fixed generate floating point types using fixed notation, or hex notation if combined with scientific
floatfield scientific|fixed|(scientific|fixed)|0. Useful for masking operations
boolalpha insert and extract bool type in alphanumeric format
showbase generate a prefix indicating the numeric base for integer output, require the currency indicator in monetary I/O
showpoint generate a decimal-point character unconditionally for floating-point number output
showpos generate a + character for non-negative numeric output
skipws skip leading whitespace before certain input operations
unitbuf flush the output after each output operation
uppercase replace certain lowercase letters with their uppercase
equivalents in certain output output operations

(typedef)
state of the stream type

The following constants are also defined:

Constant Explanation
goodbit no error
badbit irrecoverable stream error
failbit input/output operation failed (formatting or extraction error)
eofbit associated input sequence has reached end-of-file

(typedef)
seeking direction type

The following constants are also defined:

Constant Explanation
beg the beginning of a stream
end the ending of a stream
cur the current position of stream position indicator

(typedef)
specifies event type
(typedef)
callback function type
(typedef)
Retrieved from "http://en.cppreference.com/w/cpp/io/basic_istringstream"