Dokumentacja klasy common::ZlibDecompressionStream
[Moduł ZlibUtils]

Strumień do odczytu dekompresujący dane w formacie Zlib. Więcej...

#include <ZlibUtils.hpp>

Diagram dziedziczenia dla common::ZlibDecompressionStream

Lista wszystkich składowych.

Metody publiczne
	ZlibDecompressionStream (Stream *a_Stream)
virtual	~ZlibDecompressionStream ()
virtual size_t	Read (void *Out, size_t MaxLength)
	Odczytuje dane.
virtual bool	End ()
	Tak samo jak MustRead(), ale sama odczytuje rozmiar przekazanej zmiennej.
Statyczne metody publiczne
static size_t	Decompress (void *OutData, size_t BufLength, const void *Data, size_t DataLength)
	Po prostu dekompresuje podane dane.

---

Opis szczegółowy

Strumień do odczytu dekompresujący dane w formacie Zlib.

---

Dokumentacja konstruktora i destruktora

common::ZlibDecompressionStream::ZlibDecompressionStream

(

Stream *

a_Stream

)

virtual common::ZlibDecompressionStream::~ZlibDecompressionStream

(

)

[virtual]

---

Dokumentacja funkcji składowych

virtual size_t common::ZlibDecompressionStream::Read	(	void *	Data,
		size_t	MaxLength
	)			[virtual]

Odczytuje dane.

Jeśli osiągnięto koniec, funkcja nie zwraca błędu, a liczba odczytanych bajtów to 0. (W oryginale: zgłasza błąd)

Parametry:

Size

Liczba bajtów do odczytania

Zwraca:

Zwraca liczbę bajtów, jakie udało się odczytać

Reimplementowana z common::Stream.

virtual bool common::ZlibDecompressionStream::End

(

)

[virtual]

Tak samo jak MustRead(), ale sama odczytuje rozmiar przekazanej zmiennej.

Zwraca true, jeśli osiągnięto koniec strumienia (W oryginale: zgłasza błąd)

Reimplementowana z common::OverlayStream.

static size_t common::ZlibDecompressionStream::Decompress	(	void *	OutData,
		size_t	BufLength,
		const void *	Data,
		size_t	DataLength
	)			[static]

Po prostu dekompresuje podane dane.

Rozmiar danych po dekompresji musi być gdzieś zapamiętany i odpowiednio duży bufor musi być już zaalkowany.

Zwraca:

Zwraca długość rozkompresowanych danych.

Parametry:

BufLength

Długość zaalokowanej pamięci na OutData, podawana i sprawdzana na wszelki wypadek.

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• ZlibUtils.hpp