Namespaces
Variants
Views
Actions

std::basic_ostream

From cppreference.com
< cpp‎ | io
Revision as of 22:58, 31 May 2013 by P12bot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Defined in header <ostream>
template<

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

> class basic_ostream : virtual public std::basic_ios<CharT, Traits>

The class template basic_ostream provides support for high level output operations on character streams. The supported operations include formatted output (e.g. integer values) and unformatted output (e.g. raw characters and character arrays). This functionality is implemented in terms of the interface provided by the basic_streambuf class, accessed through the basic_ios base class. In typical implementations, basic_ostream has no non-inherited data members.

cpp/io/ios basecpp/io/basic iosstd-basic ostream-inheritance.svg
About this image

Inheritance diagram

Two specializations for common character types are also defined:

Defined in header <ostream>
Type Definition
ostream basic_ostream<char>
wostream basic_ostream<wchar_t>

Contents

[edit] Global objects

Six global basic_ostream objects are provided by the standard library.

Defined in header <iostream>
writes to the standard C output stream stdout
(global object) [edit]
writes to the standard C error stream stderr, unbuffered
(global object) [edit]
writes to the standard C error stream stderr
(global object) [edit]

[edit] Member types

Member type Definition
char_type CharT[edit]
traits_type Traits[edit]
int_type Traits::int_type[edit]
pos_type Traits::pos_type[edit]
off_type Traits::off_type[edit]

[edit] Member functions

constructs the object
(public member function) [edit]
[virtual]
destructs the object
(virtual public member function) [edit]
(C++11)
replaces the buffer object
(protected member function) [edit]
Formatted output
inserts formatted data
(public member function) [edit]
Unformatted output
inserts a character
(public member function) [edit]
inserts blocks of characters
(public member function) [edit]
Positioning
returns the output position indicator
(public member function) [edit]
sets the output position indicator
(public member function) [edit]
Miscellaneous
synchronizes with the underlying storage device
(public member function) [edit]
(C++11)
swaps stream objects, except for the associated buffer
(protected member function) [edit]

[edit] Member classes

implements basic logic for preparation of the stream for output operations
(public member class) [edit]

[edit] Non-member functions

inserts character data
(function template) [edit]

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

Inherited from std::ios_base

Member functions

Formatting
manages format flags
(public member function of std::ios_base) [edit]
sets specific format flag
(public member function of std::ios_base) [edit]
clears specific format flag
(public member function of std::ios_base) [edit]
manages decimal precision of floating point operations
(public member function of std::ios_base) [edit]
manages field width
(public member function of std::ios_base) [edit]
Locales
sets locale
(public member function of std::ios_base) [edit]
returns current locale
(public member function of std::ios_base) [edit]
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) [edit]
resizes the private storage if necessary and access to the long element at the given index
(public member function of std::ios_base) [edit]
resizes the private storage if necessary and access to the void* element at the given index
(public member function of std::ios_base) [edit]
Miscellaneous
registers event callback function
(public member function of std::ios_base) [edit]
sets whether C++ and C IO libraries are interoperable
(public static member function of std::ios_base) [edit]
Member classes
stream exception
(public member class of std::ios_base) [edit]
initializes standard stream objects
(public member class of std::ios_base) [edit]

Member types and constants

Type Explanation
stream open mode type

The following constants are also defined:

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

(typedef) [edit]
formatting flags type

The following constants are also defined:

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

(typedef) [edit]
state of the stream type

The following constants are also defined:

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

(typedef) [edit]
seeking direction type

The following constants are also defined:

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

(typedef) [edit]
specifies event type
(enum) [edit]
callback function type
(typedef) [edit]