Dokumentacja klasy common::VectorStream
[Moduł Stream]
Strumień pamięci, ale dynamicznej.
Więcej...
#include <Stream.hpp>
Metody publiczne | |
| VectorStream () | |
| virtual | ~VectorStream () |
| virtual void | Write (const void *Data, size_t Size) |
| Zapisuje dane. | |
| virtual size_t | Read (void *Data, size_t Size) |
| Odczytuje dane. | |
| virtual void | MustRead (void *Data, size_t Size) |
| Odczytuje tyle bajtów, ile się zażąda. | |
| virtual size_t | GetSize () |
| Zwraca rozmiar. | |
| virtual int | GetPos () |
| Zwraca pozycję względem początku. | |
| virtual void | SetPos (int pos) |
| Ustawia pozycję względem początku. | |
| virtual void | Rewind () |
| Ustawia pozycję na początku. | |
| virtual void | SetSize (size_t Size) |
| Ustawia rozmiar na podany. | |
| size_t | GetCapacity () |
| void | SetCapacity (size_t Capacity) |
| char * | Data () |
Opis szczegółowy
Strumień pamięci, ale dynamicznej.Strumień można rozszerzać i sam też się rozszerza.
Dokumentacja konstruktora i destruktora
| common::VectorStream::VectorStream | ( | ) |
| virtual common::VectorStream::~VectorStream | ( | ) | [virtual] |
Dokumentacja funkcji składowych
| virtual void common::VectorStream::Write | ( | const void * | Data, | |
| size_t | Size | |||
| ) | [virtual] |
| virtual size_t common::VectorStream::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 void common::VectorStream::MustRead | ( | void * | Data, | |
| size_t | Length | |||
| ) | [virtual] |
Odczytuje tyle bajtów, ile się zażąda.
Jeśli koniec pliku albo jeśli odczytano mniej, zgłasza błąd. (Można ją przeładować, ale nie trzeba - ma swoją wersję oryginalną)
Reimplementowana z common::Stream.
| virtual size_t common::VectorStream::GetSize | ( | ) | [inline, virtual] |
| virtual int common::VectorStream::GetPos | ( | ) | [inline, virtual] |
Zwraca pozycję względem początku.
W oryginale: zgłasza błąd.
Reimplementowana z common::SeekableStream.
| virtual void common::VectorStream::SetPos | ( | int | pos | ) | [inline, virtual] |
Ustawia pozycję względem początku.
W oryginale: zgłasza błąd.
- Parametry:
-
pos Musi być dodatnie.
Reimplementowana z common::SeekableStream.
| virtual void common::VectorStream::Rewind | ( | ) | [inline, virtual] |
Ustawia pozycję na początku.
Można ją nadpisać, ale ma wersję oryginalną.
Reimplementowana z common::SeekableStream.
| virtual void common::VectorStream::SetSize | ( | size_t | Size | ) | [virtual] |
Ustawia rozmiar na podany.
Po tym wywołaniu pozycja kursora jest niezdefiniowana. W oryginale: zgłasza błąd.
Reimplementowana z common::SeekableStream.
| size_t common::VectorStream::GetCapacity | ( | ) | [inline] |
| void common::VectorStream::SetCapacity | ( | size_t | Capacity | ) |
| char* common::VectorStream::Data | ( | ) | [inline] |
Nie musi pozostać aktualny po wywołaniach metod tej klasy! (może zostać przealokowany)
Dokumentacja dla tej klasy została wygenerowana z pliku:
