Dokumentacja klasy common::CharWriter
[Moduł Stream]

Nakładka przyspieszająca zapisująca do strumienia pojedyncze znaki i inne rzeczy. Więcej...

#include <Stream.hpp>

Lista wszystkich składowych.

Metody publiczne
	CharWriter (Stream *a_Stream)
	~CharWriter ()
void	WriteChar (char Ch)
	Zapisuje pojedynczy znak.
void	WriteString (const string &s)
	Zapisuje po prostu znaki łańcucha, bez żadnej długości.
void	WriteString (const char *s)
	Zapisuje łańcuch zakończony zerem.
void	WriteString (const char *s, size_t NumChars)
	Zapisuje łańcuch podanej długości.
void	WriteData (const void *Data, size_t Length)
	Zapisuje surowe dane binarne.
template<typename T>
void	WriteEx (const T &x)
	Zapisuje dowolną informację przerobioną na postać tekstową, o ile da się przerobić.
void	Flush ()
	Wymusza opróżnienie bufora i wysłanie pozostałych w nim danych do strumienia.

---

Opis szczegółowy

Nakładka przyspieszająca zapisująca do strumienia pojedyncze znaki i inne rzeczy.

• Nie jest strumieniem.
• Tylko zapis.
• Jest szybka, ponieważ:
  1. Nie ma metod wirtualnych.
  2. Buforuje, więc nie używa za każdym razem metod wirtualnych strumienia.
• Sama zapisuje dane pozostałe w buforze w destruktorze. Jeśli chcesz to zrobić wcześniej i z kontrolą błędów, wywołaj CharWriter::Flush().
• W trybie Debug działa nawet trochę wolniej niż zapisywanie po bajcie prosto do strumienia. W trybie Release daje przyspieszenie prawie 10x względem zapisywania po bajcie prosto do strumienia.
• Celowo nie używam w tej klasie ERR_TRY .. ERR_CATCH_FUNC, żeby było szybciej.

---

Dokumentacja konstruktora i destruktora

common::CharWriter::CharWriter

(

Stream *

a_Stream

)

[inline]

common::CharWriter::~CharWriter

(

)

---

Dokumentacja funkcji składowych

void common::CharWriter::WriteChar

(

char

Ch

)

[inline]

Zapisuje pojedynczy znak.

void common::CharWriter::WriteString

(

const string &

s

)

Zapisuje po prostu znaki łańcucha, bez żadnej długości.

void common::CharWriter::WriteString

(

const char *

s

)

[inline]

Zapisuje łańcuch zakończony zerem.

void common::CharWriter::WriteString	(	const char *	s,
		size_t	NumChars
	)			[inline]

Zapisuje łańcuch podanej długości.

void common::CharWriter::WriteData	(	const void *	Data,
		size_t	Length
	)

Zapisuje surowe dane binarne.

template<typename T>

void common::CharWriter::WriteEx

(

const T &

x

)

[inline]

Zapisuje dowolną informację przerobioną na postać tekstową, o ile da się przerobić.

void common::CharWriter::Flush

(

)

[inline]

Wymusza opróżnienie bufora i wysłanie pozostałych w nim danych do strumienia.

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• Stream.hpp