std::basic_streambuf

 

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_streambuf

Öffentliche Memberfunktionen basic_streambuf::~basic_streambuf      Lokale basic_streambuf::pubimbue basic_streambuf::getloc Positionierung basic_streambuf::pubsetbuf basic_streambuf::pubseekoff basic_streambuf::pubseekpos basic_streambuf::pubsync Get-Bereich basic_streambuf::in_avail basic_streambuf::snextc basic_streambuf::sbumpc basic_streambuf::sgetc basic_streambuf::sgetn Put-Bereich basic_streambuf::sputc basic_streambuf::sputn Putback basic_streambuf::sputbackc basic_streambuf::sungetc

Geschützte Memberfunktionen basic_streambuf::basic_streambuf basic_streambuf::operator= (C++11) basic_streambuf::swap (C++11) Lokale basic_streambuf::imbue Positionierung basic_streambuf::setbuf basic_streambuf::seekoff basic_streambuf::seekpos basic_streambuf::sync Get-Bereich basic_streambuf::showmanyc basic_streambuf::underflow basic_streambuf::uflow basic_streambuf::xsgetn basic_streambuf::ebackbasic_streambuf::gptrbasic_streambuf::egptr basic_streambuf::gbump basic_streambuf::setg Put-Bereich basic_streambuf::xsputn basic_streambuf::overflow basic_streambuf::pbasebasic_streambuf::pptrbasic_streambuf::epptr basic_streambuf::pbump basic_streambuf::setp Putback basic_streambuf::pbackfail

 

Definiert in Header <streambuf>
template<     class CharT,     class Traits = std::char_traits<CharT> > class basic_streambuf;

Die Klasse basic_streambuf steuert die Eingabe und Ausgabe einer Zeichensequenz. Sie enthält und stellt Zugriff auf

1. Die gesteuerte Zeichensequenz, auch als Puffer bezeichnet, welche eine Eingabesequenz (auch als Get-Bereich bezeichnet) zur Pufferung von Eingabeoperationen und/oder eine Ausgabesequenz (auch als Put-Bereich bezeichnet) zur Pufferung von Ausgabeoperationen enthalten kann.
2. Die assoziierte Zeichensequenz, auch als Quelle (für Eingabe) oder Senke (für Ausgabe) bezeichnet. Dies kann eine Entität sein, auf die über eine Betriebssystem-API (Datei, TCP-Socket, serielle Schnittstelle, anderes Zeichengerät) zugegriffen wird, oder es kann ein Objekt sein (std::vector, Array, String-Literal), das als Zeichenquelle oder -senke interpretiert werden kann.

Die I/O-Stream-Objekte std::basic_istream und std::basic_ostream sowie alle von ihnen abgeleiteten Objekte (std::ofstream, std::stringstream usw.) werden vollständig auf Basis von std::basic_streambuf implementiert.

Die gesteuerte Zeichensequenz ist ein Array von CharT, das jederzeit eine Teilsequenz oder ein "Fenster" in die assoziierte Zeichensequenz darstellt. Sein Zustand wird durch drei Zeiger beschrieben

1. Der Anfangszeiger zeigt immer auf das unterste Element des Puffers.
2. Der Nächstzeiger zeigt auf das Element, das der nächste Kandidat für Lesen oder Schreiben ist.
3. Der Endzeiger zeigt auf eine Position hinter dem Ende des Puffers.

Ein basic_streambuf-Objekt kann Eingabe (in diesem Fall wird der durch die Anfangs-, Nächste- und Endzeiger beschriebene Puffer als Get-Bereich bezeichnet), Ausgabe (Put-Bereich) oder gleichzeitig Eingabe und Ausgabe unterstützen. In letzterem Fall werden sechs Zeiger verwaltet, die alle auf Elemente desselben Zeichenarrays oder auf zwei einzelne Arrays zeigen können.

Wenn der Nächste-Zeiger im Put-Bereich kleiner als der Endzeiger ist, ist eine Schreibposition verfügbar. Der Nächste-Zeiger kann dereferenziert und zugewiesen werden.

Wenn der Nächste-Zeiger im Get-Bereich kleiner als der Endzeiger ist, ist eine Leseposition verfügbar. Der Nächste-Zeiger kann dereferenziert und gelesen werden.

Wenn der Nächste-Zeiger in einem Get-Bereich größer als der Anfangszeiger ist, ist eine Putback-Position verfügbar, und der Nächste-Zeiger kann dekrementiert, dereferenziert und zugewiesen werden, um ein Zeichen in den Get-Bereich zurückzulegen.

Die Zeichenrepräsentation und Kodierung in der gesteuerten Sequenz kann sich von den Zeichenrepräsentationen in der assoziierten Sequenz unterscheiden. In diesem Fall wird typischerweise eine std::codecvt Locale Facette verwendet, um die Konvertierung durchzuführen. Gängige Beispiele sind UTF-8-Dateien (oder andere Multibyte-Dateien), auf die über std::wfstream-Objekte zugegriffen wird: Die gesteuerte Sequenz besteht aus wchar_t-Zeichen, aber die assoziierte Sequenz besteht aus Bytes.

Die typische Implementierung der Basisklasse std::basic_streambuf enthält nur die sechs CharT*-Zeiger und eine Kopie von std::locale als Datenmember. Zusätzlich können Implementierungen zwischengespeicherte Kopien von Locale Facetten enthalten, die ungültig werden, wenn imbue() aufgerufen wird. Die konkreten Puffer wie std::basic_filebuf oder std::basic_stringbuf leiten sich von std::basic_streambuf ab.

Mehrere Typedefs für gängige Zeichentypen werden bereitgestellt

Definiert in Header <streambuf>
Typ	Definition
std::streambuf	std::basic_streambuf<char>
std::wstreambuf	std::basic_streambuf<wchar_t>

Member-Typen

Mitgliedertyp	Definition
char_type	CharT
traits_type	Traits; das Programm ist fehlerhaft, wenn Traits::char_type nicht CharT ist.
int_type	Traits::int_type
pos_type	Traits::pos_type
off_type	Traits::off_type

Memberfunktionen

(Destruktor) [virtuell]	zerstört das basic_streambuf-Objekt (virtuelle öffentliche Memberfunktion)
Lokale
pubimbue	ändert die zugeordnete Locale und ruft imbue() auf (öffentliche Memberfunktion)
getloc	holt eine Kopie der zugeordneten Locale (öffentliche Memberfunktion)
Positionierung
pubsetbuf	ruft setbuf() auf (öffentliche Memberfunktion)
pubseekoff	ruft seekoff() auf (öffentliche Memberfunktion)
pubseekpos	ruft seekpos() auf (öffentliche Memberfunktion)
pubsync	ruft sync() auf (öffentliche Memberfunktion)
Get-Bereich
in_avail	holt die Anzahl der im Get-Bereich sofort verfügbaren Zeichen (öffentliche Memberfunktion)
snextc	bewegt die Eingabesequenz vorwärts und liest dann ein Zeichen, ohne erneut vorzurücken (öffentliche Memberfunktion)
sbumpcstossc (in C++17 entfernt)	liest ein Zeichen aus der Eingabesequenz und rückt die Sequenz vor (öffentliche Memberfunktion)
sgetc	liest ein Zeichen aus der Eingabesequenz, ohne die Sequenz vorzurücken (öffentliche Memberfunktion)
sgetn	ruft xsgetn() auf (öffentliche Memberfunktion)
Put-Bereich
sputc	schreibt ein Zeichen in den Put-Bereich und rückt den nächsten Zeiger vor (öffentliche Memberfunktion)
sputn	ruft xsputn() auf (öffentliche Memberfunktion)
Putback
sputbackc	legt ein Zeichen zurück in die Eingabesequenz (öffentliche Memberfunktion)
sungetc	verschiebt den nächsten Zeiger in der Eingabesequenz um eins zurück (öffentliche Memberfunktion)
Geschützte Memberfunktionen
(Konstruktor)	konstruiert ein basic_streambuf-Objekt (geschützte Member-Funktion)
operator= (C++11)	ersetzt ein basic_streambuf-Objekt (geschützte Member-Funktion)
swap (C++11)	tauscht zwei basic_streambuf-Objekte (geschützte Member-Funktion)
Lokale
imbue [virtuell]	reagiert auf eine Änderung der zugeordneten Locale (virtuelle geschützte Memberfunktion)
Positionierung
setbuf [virtuell]	ersetzt den Puffer durch ein benutzerdefiniertes Array, falls zulässig (virtuelle geschützte Memberfunktion)
seekoff [virtuell]	positioniert den nächsten Zeiger in der Eingabesequenz, Ausgabesequenz oder beidem neu, unter Verwendung relativer Adressierung (virtuelle geschützte Memberfunktion)
seekpos [virtuell]	positioniert den nächsten Zeiger in der Eingabesequenz, Ausgabesequenz oder beidem neu, unter Verwendung absoluter Adressierung (virtuelle geschützte Memberfunktion)
sync [virtuell]	synchronisiert die Puffer mit der zugeordneten Zeichensequenz (virtuelle geschützte Memberfunktion)
Get-Bereich
showmanyc [virtuell]	holt die Anzahl der für die Eingabe in der zugeordneten Eingabesequenz verfügbaren Zeichen, falls bekannt (virtuelle geschützte Memberfunktion)
underflow [virtuell]	liest Zeichen aus der zugeordneten Eingabesequenz in den Get-Bereich (virtuelle geschützte Memberfunktion)
uflow [virtuell]	liest Zeichen aus der zugeordneten Eingabesequenz in den Get-Bereich und rückt den nächsten Zeiger vor (virtuelle geschützte Memberfunktion)
xsgetn [virtuell]	liest mehrere Zeichen aus der Eingabesequenz (virtuelle geschützte Memberfunktion)
ebackgptregptr	gibt einen Zeiger auf den Anfang, das aktuelle Zeichen und das Ende des Get-Bereichs zurück (geschützte Member-Funktion)
gbump	rückt den nächsten Zeiger in der Eingabesequenz vor (geschützte Member-Funktion)
setg	positioniert die Zeiger für Anfang, nächsten und Ende der Eingabesequenz neu (geschützte Member-Funktion)
Put-Bereich
xsputn [virtuell]	schreibt mehrere Zeichen in die Ausgabesequenz (virtuelle geschützte Memberfunktion)
overflow [virtuell]	schreibt Zeichen aus dem Put-Bereich in die zugeordnete Ausgabesequenz (virtuelle geschützte Memberfunktion)
pbasepptrepptr	gibt einen Zeiger auf den Anfang, das aktuelle Zeichen und das Ende des Put-Bereichs zurück (geschützte Member-Funktion)
pbump	rückt den nächsten Zeiger der Ausgabesequenz vor (geschützte Member-Funktion)
setp	positioniert die Zeiger für Anfang, nächsten und Ende der Ausgabesequenz neu (geschützte Member-Funktion)
Putback
pbackfail [virtuell]	legt ein Zeichen in die Eingabesequenz zurück, möglicherweise unter Änderung der Eingabesequenz (virtuelle geschützte Memberfunktion)

Siehe auch

FILE	Objekttyp, der alle für die Steuerung eines C-I/O-Streams benötigten Informationen speichern kann (typedef)