CBufFlat Class Reference

class CBufFlat : public CBufBase

Provides a flat storage dynamic buffer.

This class should be used when high-speed pointer lookup is an important consideration, and you are reasonably confident that the insertion of data will not fail.

This class is an implementation of the abstract buffer interface provided by CBufBase and uses a single heap cell to contain the data.

Inherits from

Constructor & Destructor Documentation

CBufFlat(TInt)

IMPORT_CCBufFlat(TIntanExpandSize)[protected]

Parameters

TInt anExpandSize

~CBufFlat()

IMPORT_C~CBufFlat()

Destructor.

Frees all resources owned by the object, prior to its destruction. Specifically, it frees the allocated cell used as a buffer.

Member Functions Documentation

BackPtr(TInt)

IMPORT_C TPtr8BackPtr(TIntaPos)[virtual]

Gets a pointer descriptor to represent the data starting at the beginning of the contiguous region containing that byte through to the byte immediately preceding the specified byte.

The descriptor always points to the beginning of the buffer containing the specified byte. Calculation of the pointer and length involves only a few machine instructions and is independent of the data contained in the buffer.

CBufBase::BackPtr

Parameters

TInt aPosBuffer position: must be in range zero to Size().

Capacity()

TInt Capacity()const [inline]

Gets the size to which the buffer may expand without re-allocation.

Compress()

IMPORT_C voidCompress()[virtual]

Compresses the buffer so as to occupy minimal space.

This frees any unused memory at the end of the buffer.

CBufBase::Compress

Delete(TInt, TInt)

IMPORT_C voidDelete(TIntaPos,
TIntaLength
)[virtual]

Deletes data from the buffer.

During deletion, any data beyond the deleted data is shuffled up so that the buffer contents are contiguous. No memory is freed.

panic
E32USER-CBase 12, if aPos is negative or is greater than the current size of the buffer.
panic
E32USER-CBase 13, if aPos + aLength is greater than the current size of the buffer.
CBufBase::Delete

Parameters

TInt aPosBuffer position where the deletion will begin; must be in the range zero to (Size() minus the length of the data to be deleted).
TInt aLengthThe number of bytes to be deleted.

DoInsertL(TInt, const TAny *, TInt)

IMPORT_C voidDoInsertL(TIntaPos,
const TAny *aPtr,
TIntaLength
)[private, virtual]

Parameters

TInt aPos
const TAny * aPtr
TInt aLength

NewL(TInt)

IMPORT_C CBufFlat *NewL(TIntanExpandSize)[static]

Allocates and constructs a flat buffer.

If there is insufficient memory available to allocate the flat buffer, the function leaves.

panic
E32USER-CBase 3 if the granularity is negative.

Parameters

TInt anExpandSizeThe granularity of buffer expansion. Additional space, when required, is always allocated in multiples of this number. Note: although a value of zero is permitted by this interface, it has no meaning, and risks raising panics later during execution. We suggest that you pass a positive value.

Ptr(TInt)

IMPORT_C TPtr8Ptr(TIntaPos)[virtual]

Gets a pointer descriptor to represent the data starting at the specified data byte through to the end of the contiguous region containing that byte.

Calculation of the pointer and length involves only a few machine instructions and is independent of the data contained in the buffer.

Parameters

TInt aPosBuffer position: must be in range zero to Size().

SetReserveL(TInt)

IMPORT_C voidSetReserveL(TIntaSize)

Specifies a minimum amount of space which the flat buffer should occupy.

If the required size is zero, the heap cell is deleted. If it is different from the current size, the heap cell is rellocated accordingly.

panic
E32USER-CBase 10, if aSize is negative.
panic
E32USER-CBase 11, if there is data in the buffer, and aSize is less than the value returned by Size().

Parameters

TInt aSizeThe size of the buffer required. If there is no data in the buffer, i.e. Size() returns zero, then this value can be zero, which causes the buffer's allocated heap cell to be deleted.

Member Data Documentation

TInt iMaxSize

TInt iMaxSize[private]

TUint8 * iPtr

TUint8 *iPtr[private]