Dokumentacja klasy common::GzipDecompressionStream
[Moduł ZlibUtils]
Strumień do odczytu, który dekompresuje dane w formacie gzip odczytując też nagłówek.
Więcej...
#include <ZlibUtils.hpp>
Diagram dziedziczenia dla common::GzipDecompressionStream
Metody publiczne | |
| GzipDecompressionStream (Stream *a_Stream) | |
| virtual | ~GzipDecompressionStream () |
| virtual size_t | Read (void *Out, size_t MaxLength) |
| Odczytuje dane. | |
| virtual bool | End () |
| Tak samo jak MustRead(), ale sama odczytuje rozmiar przekazanej zmiennej. | |
Pobieranie informacji z nagłówka. | |
Jeśli plik posiada nagłówek, ten nagłówek przechowuje daną informację i został już w toku odczytywania odczytany, zwraca true i zwraca przez parametr z tą informację. | |
| bool | GetHeaderFileName (string *OutFileName) |
| bool | GetHeaderComment (string *OutComment) |
Opis szczegółowy
Strumień do odczytu, który dekompresuje dane w formacie gzip odczytując też nagłówek.Wszystko podobnie jak w klasie ZlibCompressionStream.
Dokumentacja konstruktora i destruktora
| common::GzipDecompressionStream::GzipDecompressionStream | ( | Stream * | a_Stream | ) |
| virtual common::GzipDecompressionStream::~GzipDecompressionStream | ( | ) | [virtual] |
Dokumentacja funkcji składowych
| virtual size_t common::GzipDecompressionStream::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::GzipDecompressionStream::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.
| bool common::GzipDecompressionStream::GetHeaderFileName | ( | string * | OutFileName | ) |
| bool common::GzipDecompressionStream::GetHeaderComment | ( | string * | OutComment | ) |
Dokumentacja dla tej klasy została wygenerowana z pliku:
