std::basic_ostream<CharT,Traits>::sentry

 

C++

Compiler-Unterstützung

Freestanding und gehostet

Sprache

Standardbibliothek

Header der Standardbibliothek

Benannte Anforderungen

Feature-Test-Makros (C++20)

Bibliothek für Sprachunterstützung

Konzepte-Bibliothek (C++20)

Diagnostik-Bibliothek

Speicherverwaltungsbibliothek

Metaprogrammierungsbibliothek (C++11)

Allgemeine Dienstprogramme-Bibliothek

Container-Bibliothek

Iterator-Bibliothek

Ranges-Bibliothek (C++20)

Algorithmen-Bibliothek

Bibliothek für Zeichenketten

Textverarbeitungsbibliothek

Numerik-Bibliothek

Datums- und Zeitbibliothek

Ein-/Ausgabe-Bibliothek

Dateisystembibliothek (C++17)

Unterstützung für nebenläufige Programmierung (C++11)

Ausführungssteuerungsbibliothek (C++26)

Technische Spezifikationen

Symbolverzeichnis

Externe Bibliotheken

 

Ein-/Ausgabe-Bibliothek

I/O-Manipulatoren

Print-Funktionen (C++23)

C-Style I/O

Puffer

basic_streambuf

basic_filebuf

basic_stringbuf

basic_spanbuf (C++23)

strstreambuf (C++98/26*)

basic_syncbuf (C++20)

Streams

Abstraktionen

ios_base

basic_ios

basic_istream

basic_ostream

basic_iostream

Datei-I/O

basic_ifstream

basic_ofstream

basic_fstream

String-I/O

basic_istringstream

basic_ostringstream

basic_stringstream

Array-I/O

basic_ispanstream (C++23)

basic_ospanstream (C++23)

basic_spanstream (C++23)

istrstream (C++98/26*)

ostrstream (C++98/26*)

strstream (C++98/26*)

Synchronisierte Ausgabe

basic_osyncstream (C++20)

Typen

streamoff

streamsize

fpos

Fehlerkategorie-Schnittstelle

iostream_category (C++11)

io_errc (C++11)

 

std::basic_ostream

Globale Objekte
coutwcout	cerrwcerr	clogwclog
Memberfunktionen
basic_ostream::basic_ostream
basic_ostream::~basic_ostream
basic_ostream::operator= (C++11)
Formatierte Ausgabe
basic_ostream::operator<<
Unformatierte Ausgabe
basic_ostream::put
basic_ostream::write
Positionierung
basic_ostream::tellp
basic_ostream::seekp
Sonstiges
basic_ostream::flush
basic_ostream::swap (C++11)
Member-Klassen
basic_ostream::sentry
Nicht-Member-Funktionen
operator<<(std::basic_ostream)
print(std::ostream) (C++23)
println(std::ostream) (C++23)
vprint_unicode(std::ostream) (C++23)
vprint_nonunicode(std::ostream) (C++23)

 

class sentry;

Ein Objekt der Klasse basic_ostream::sentry wird im lokalen Geltungsbereich zu Beginn jeder Memberfunktion von std::basic_ostream konstruiert, die eine Ausgabe durchführt (sowohl formatierte als auch unformatierte). Sein Konstruktor bereitet den Ausgabestrom vor: Er prüft, ob der Strom bereits in einem fehlerhaften Zustand ist, spült die gebundenen Ausgabeströme und führt bei Bedarf weitere implementierungsabhängige Aufgaben aus. Implementierungsabhängige Bereinigungen sowie das Spülen des Ausgabestroms bei Bedarf werden im Destruktor durchgeführt, sodass sichergestellt ist, dass sie auch dann erfolgen, wenn während der Ausgabe Ausnahmen ausgelöst werden.

Memberfunktionen

(Konstruktor)	konstruiert das sentry-Objekt. Alle Vorbereitungsschritte werden hier durchgeführt (öffentliche Memberfunktion)
(Destruktor)	finalisiert das Stream-Objekt nach formatierten Ausgaben oder nach Ausnahmen, falls erforderlich (öffentliche Memberfunktion)
operator=	der Zuweisungsoperator ist gelöscht (öffentliche Memberfunktion)
operator bool	prüft, ob die Vorbereitung des Stream-Objekts erfolgreich war (öffentliche Memberfunktion)

std::basic_ostream::sentry::sentry

explicit sentry( std::basic_ostream<CharT, Traits>& os );

Bereitet den Strom für die formatierte Ausgabe vor.

Wenn os.good() false ist, wird zurückgekehrt. Andernfalls, wenn os.tie() kein Nullzeiger ist, wird os.tie()->flush() aufgerufen, um die Ausgabesequenz mit externen Strömen zu synchronisieren. Während der Vorbereitung kann der Konstruktor setstate(failbit) aufrufen (was std::ios_base::failure auslösen kann).

Wenn nach Abschluss der Vorbereitung os.good() == true ist, geben alle nachfolgenden Aufrufe von operator bool true zurück.

Parameter

os

-

Ausgabestrom, der vorbereitet werden soll

Ausnahmen

std::ios_base::failure, wenn das Dateiende auftritt.

std::basic_ostream::sentry::~sentry

~sentry();

Wenn (os.flags() & std::ios_base::unitbuf) && !std::uncaught_exception() && os.good()) true ist, wird os.rdbuf()->pubsync() aufgerufen. Wenn diese Funktion -1 zurückgibt, wird badbit in os.rdstate() gesetzt, ohne eine Ausnahme weiterzugeben.

std::basic_ostream::sentry::operator bool

explicit operator bool() const;

Prüft, ob die Vorbereitung des Ausgabestroms erfolgreich war.

Parameter

(keine)

Rückgabewert

true, wenn die Vorbereitung des Ausgabestroms erfolgreich war, false andernfalls.

Beispiel

Führen Sie diesen Code aus

#include <iostream>
#include <sstream>
 
struct Foo
{
    char n[6];
};
 
std::ostream& operator<<(std::ostream& os, Foo& f)
{
    std::ostream::sentry s(os);
    if (s)
        os.write(f.n, 5);
    return os;
}
 
int main()
{
    Foo f = {"abcde"};
    std::cout << f << '\n';
}

Ausgabe

abcde

Fehlerberichte

Die folgenden Verhaltensändernden Fehlerberichte wurden rückwirkend auf zuvor veröffentlichte C++-Standards angewendet.

DR	angewendet auf	Verhalten wie veröffentlicht	Korrigiertes Verhalten
LWG 397	C++98	der Destruktor könnte os.flush() aufrufen, was Ausnahmen auslösen kann	die Ausnahme wird nicht weitergegeben
LWG 442	C++98	operator bool war nicht als const deklariert (in der Synopse ist sie const)	const hinzugefügt
LWG 835	C++98	wenn os unitbuf setzt, würde der Destruktor os.flush() aufrufen, was eine UnformattedOutputFunction ist und ein weiteres sentry-Objekt erstellt (dessen Destruktor dann wiederum ein weiteres sentry-Objekt erstellt und so weiter)	ruft os.rdbuf()->pubsync() in diesem Fall stattdessen auf

Siehe auch

operator<<

fügt formatierte Daten ein (public member function)