RBuf8 Class Reference

class RBuf8 : public TDes8

8 bit resizable buffer descriptor.

The class provides a buffer that contains, accesses and manipulates TUint8 data. The buffer itself is on the heap, and is managed by the class.

Internally, RBuf8 behaves in one of two ways:

  • as a TPtr8 descriptor type, where the buffer just contains data

  • as a pointer to a heap descriptor, an HBufC8* type, where the buffer contains both descriptor information and the data.

Note that the handling of the distinction is hidden from view.

An RBuf8 object can allocate its own buffer. Alternatively, it can take ownership of a pre-existing section of allocated memory, or it can take ownership of a pre-existing heap descriptor. It can also reallocate the buffer to resize it. Regardless of the way in which the buffer has been allocated, the RBuf8 object is responsible for freeing memory when the object itself is closed.

The class is intended for instantiation.

The class is derived from TDes8, which means that data can be both accessed and modified. The base classes provide the functions through which the data is accessed. In addition, an RBuf8 object can be passed to any function that is prototyped to take a TDes8 or a TDesC8 type.

TBuf8

TPtr8

HBufC8

TDesC8

TDes8

Inherits from

Public Member Functions
RBuf8()
RBuf8(HBufC8 *)
IMPORT_C voidAssign(const RBuf8 &)
IMPORT_C voidAssign(TUint8 *, TInt)
IMPORT_C voidAssign(TUint8 *, TInt, TInt)
IMPORT_C voidAssign(HBufC8 *)
IMPORT_C voidCleanupClosePushL()
IMPORT_C voidClose()
IMPORT_C TIntCreate(TInt)
IMPORT_C TIntCreate(const TDesC8 &)
IMPORT_C TIntCreate(const TDesC8 &, TInt)
IMPORT_C voidCreateL(TInt)
voidCreateL(RReadStream &, TInt)
IMPORT_C voidCreateL(const TDesC8 &)
IMPORT_C voidCreateL(const TDesC8 &, TInt)
IMPORT_C TIntCreateMax(TInt)
IMPORT_C voidCreateMaxL(TInt)
IMPORT_C TIntReAlloc(TInt)
IMPORT_C voidReAllocL(TInt)
IMPORT_C voidSwap(RBuf8 &)
RBuf8 &operator=(const TUint8 *)
RBuf8 &operator=(const TDesC8 &)
RBuf8 &operator=(const RBuf8 &)
Protected Member Functions
RBuf8(TInt, TInt, TInt)
RBuf8(const RBuf8 &)
Inherited Functions
TDes8::Append(TChar)
TDes8::Append(const TDesC16 &)
TDes8::Append(const TDesC8 &)
TDes8::Append(const TUint8 *,TInt)
TDes8::AppendFill(TChar,TInt)
TDes8::AppendFormat(TRefByValue< const TDesC8 >,...)
TDes8::AppendFormat(TRefByValue< const TDesC8 >,TDes8Overflow *,...)
TDes8::AppendFormatList(const TDesC8 &,VA_LIST,TDes8Overflow *)
TDes8::AppendJustify(const TDesC8 &,TInt,TAlign,TChar)
TDes8::AppendJustify(const TDesC8 &,TInt,TInt,TAlign,TChar)
TDes8::AppendJustify(const TUint8 *,TInt,TAlign,TChar)
TDes8::AppendJustify(const TUint8 *,TInt,TInt,TAlign,TChar)
TDes8::AppendNum(TInt64)
TDes8::AppendNum(TReal,const TRealFormat &)
TDes8::AppendNum(TUint64,TRadix)
TDes8::AppendNumFixedWidth(TUint,TRadix,TInt)
TDes8::AppendNumFixedWidthUC(TUint,TRadix,TInt)
TDes8::AppendNumUC(TUint64,TRadix)
TDes8::Capitalize()
TDes8::Collapse()
TDes8::Collate()
TDes8::Copy(const TDesC16 &)
TDes8::Copy(const TDesC8 &)
TDes8::Copy(const TUint8 *)
TDes8::Copy(const TUint8 *,TInt)
TDes8::CopyC(const TDesC8 &)
TDes8::CopyCP(const TDesC8 &)
TDes8::CopyF(const TDesC8 &)
TDes8::CopyLC(const TDesC8 &)
TDes8::CopyUC(const TDesC8 &)
TDes8::Delete(TInt,TInt)
TDes8::DoAppendNum(TUint64,TRadix,TUint,TInt)
TDes8::DoPadAppendNum(TInt,TInt,const TUint8 *)
TDes8::Expand()
TDes8::Fill(TChar)
TDes8::Fill(TChar,TInt)
TDes8::FillZ()
TDes8::FillZ(TInt)
TDes8::Fold()
TDes8::Format(TRefByValue< const TDesC8 >,...)
TDes8::FormatList(const TDesC8 &,VA_LIST)
TDes8::Insert(TInt,const TDesC8 &)
TDes8::Justify(const TDesC8 &,TInt,TAlign,TChar)
TDes8::LeftTPtr(TInt)const
TDes8::LowerCase()
TDes8::MaxLength()const
TDes8::MaxSize()const
TDes8::MidTPtr(TInt)const
TDes8::MidTPtr(TInt,TInt)const
TDes8::Num(TInt64)
TDes8::Num(TReal,const TRealFormat &)
TDes8::Num(TUint64,TRadix)
TDes8::NumFixedWidth(TUint,TRadix,TInt)
TDes8::NumFixedWidthUC(TUint,TRadix,TInt)
TDes8::NumUC(TUint64,TRadix)
TDes8::PtrZ()
TDes8::Repeat(const TDesC8 &)
TDes8::Repeat(const TUint8 *,TInt)
TDes8::Replace(TInt,TInt,const TDesC8 &)
TDes8::RightTPtr(TInt)const
TDes8::SetLength(TInt)
TDes8::SetMax()
TDes8::Swap(TDes8 &)
TDes8::TDes8()
TDes8::TDes8(TInt,TInt,TInt)
TDes8::Trim()
TDes8::TrimAll()
TDes8::TrimLeft()
TDes8::TrimRight()
TDes8::UpperCase()
TDes8::WPtr()const
TDes8::Zero()
TDes8::ZeroTerminate()
TDes8::operator+=(const TDesC8 &)
TDes8::operator=(const TDes8 &)
TDes8::operator[](TInt)
TDes8::operator[](TInt)const
TDesC8::Alloc()const
TDesC8::AllocL()const
TDesC8::AllocLC()const
TDesC8::AtC(TInt)const
TDesC8::Compare(const TDesC8 &)const
TDesC8::CompareC(const TDesC8 &)const
TDesC8::CompareF(const TDesC8 &)const
TDesC8::DoSetLength(TInt)
TDesC8::Find(const TDesC8 &)const
TDesC8::Find(const TUint8 *,TInt)const
TDesC8::FindC(const TDesC8 &)const
TDesC8::FindC(const TUint8 *,TInt)const
TDesC8::FindF(const TDesC8 &)const
TDesC8::FindF(const TUint8 *,TInt)const
TDesC8::Left(TInt)const
TDesC8::Length()const
TDesC8::Locate(TChar)const
TDesC8::LocateF(TChar)const
TDesC8::LocateReverse(TChar)const
TDesC8::LocateReverseF(TChar)const
TDesC8::Match(const TDesC8 &)const
TDesC8::MatchC(const TDesC8 &)const
TDesC8::MatchF(const TDesC8 &)const
TDesC8::Mid(TInt)const
TDesC8::Mid(TInt,TInt)const
TDesC8::Ptr()const
TDesC8::Right(TInt)const
TDesC8::Size()const
TDesC8::TDesC8()
TDesC8::TDesC8(TInt,TInt)
TDesC8::Type()const
TDesC8::operator!=(const TDesC8 &)const
TDesC8::operator<(const TDesC8 &)const
TDesC8::operator<=(const TDesC8 &)const
TDesC8::operator==(const TDesC8 &)const
TDesC8::operator>(const TDesC8 &)const
TDesC8::operator>=(const TDesC8 &)const
Public Attributes
HBufC8 *iEBufCPtrType
TUint8 *iEPtrType
Protected Attributes
union RBuf8::@7@8
__DECLARE_TEST
Inherited Attributes
TDes8::iMaxLength

Constructor & Destructor Documentation

RBuf8()

IMPORT_CRBuf8()

RBuf8(HBufC8 *)

IMPORT_CRBuf8(HBufC8 *aHBuf)[explicit]

Parameters

HBufC8 * aHBuf

RBuf8(TInt, TInt, TInt)

IMPORT_CRBuf8(TIntaType,
TIntaLength,
TIntaMaxLength
)[protected]

Parameters

TInt aType
TInt aLength
TInt aMaxLength

RBuf8(const RBuf8 &)

RBuf8(const RBuf8 &)[protected]

Parameters

const RBuf8 &

Member Functions Documentation

Assign(const RBuf8 &)

IMPORT_C voidAssign(const RBuf8 &aRBuf)

Parameters

const RBuf8 & aRBuf

Assign(TUint8 *, TInt)

IMPORT_C voidAssign(TUint8 *aHeapCell,
TIntaMaxLength
)

Parameters

TUint8 * aHeapCell
TInt aMaxLength

Assign(TUint8 *, TInt, TInt)

IMPORT_C voidAssign(TUint8 *aHeapCell,
TIntaLength,
TIntaMaxLength
)

Parameters

TUint8 * aHeapCell
TInt aLength
TInt aMaxLength

Assign(HBufC8 *)

IMPORT_C voidAssign(HBufC8 *aHBuf)

Parameters

HBufC8 * aHBuf

CleanupClosePushL()

IMPORT_C voidCleanupClosePushL()

Close()

IMPORT_C voidClose()

Create(TInt)

IMPORT_C TIntCreate(TIntaMaxLength)

Parameters

TInt aMaxLength

Create(const TDesC8 &)

IMPORT_C TIntCreate(const TDesC8 &aDes)

Parameters

const TDesC8 & aDes

Create(const TDesC8 &, TInt)

IMPORT_C TIntCreate(const TDesC8 &aDes,
TIntaMaxLength
)

Parameters

const TDesC8 & aDes
TInt aMaxLength

CreateL(TInt)

IMPORT_C voidCreateL(TIntaMaxLength)

Parameters

TInt aMaxLength

CreateL(RReadStream &, TInt)

voidCreateL(RReadStream &aStream,
TIntaMaxLength
)[inline]

Creates an 8-bit resizable buffer descriptor that has been initialised with data from the specified read stream; leaves on failure.

Data is assigned to the new descriptor from the specified stream. This variant assumes that the stream contains the length of the data followed by the data itself.

The function is implemented by calling the HBufC8::NewL(RReadStream&,TInt) variant and then assigning the resulting heap descriptor using the RBuf8::Assign(HBufC8*) variant. The comments that describe the HBufC8::NewL() variant also apply to this RBuf8::CreateL() function.

The function may leave with one of the system-wide error codes, specifically KErrOverflow, if the length of the data as read from the stream is greater than the upper limit as specified by the aMaxLength parameter.

Parameters

RReadStream & aStreamThe stream from which the data length and the data to be assigned to the new descriptor, are taken.
TInt aMaxLengthThe upper limit on the length of data that the descriptor is to represent. The value of this parameter must be non-negative otherwise the underlying function will panic.

CreateL(const TDesC8 &)

IMPORT_C voidCreateL(const TDesC8 &aDes)

Parameters

const TDesC8 & aDes

CreateL(const TDesC8 &, TInt)

IMPORT_C voidCreateL(const TDesC8 &aDes,
TIntaMaxLength
)

Parameters

const TDesC8 & aDes
TInt aMaxLength

CreateMax(TInt)

IMPORT_C TIntCreateMax(TIntaMaxLength)

Parameters

TInt aMaxLength

CreateMaxL(TInt)

IMPORT_C voidCreateMaxL(TIntaMaxLength)

Parameters

TInt aMaxLength

ReAlloc(TInt)

IMPORT_C TIntReAlloc(TIntaMaxLength)

Parameters

TInt aMaxLength

ReAllocL(TInt)

IMPORT_C voidReAllocL(TIntaMaxLength)

Parameters

TInt aMaxLength

Swap(RBuf8 &)

IMPORT_C voidSwap(RBuf8 &aRBuf)

Parameters

RBuf8 & aRBuf

operator=(const TUint8 *)

RBuf8 &operator=(const TUint8 *aString)[inline]

Copies data into this descriptor replacing any existing data.

The length of this descriptor is set to reflect the new data.

A reference to this, the target descriptor.

panic

USER 11, if the length of the string, excluding the zero terminator, is greater than the maximum length of this (target) descriptor.

Parameters

const TUint8 * aStringA pointer to a zero-terminated string.

operator=(const TDesC8 &)

RBuf8 &operator=(const TDesC8 &aDes)[inline]

Copies data into this descriptor replacing any existing data.

The length of this descriptor is set to reflect the new data.

A reference to this, the target descriptor.

panic

USER 11, if the length of the descriptor aDes is greater than the maximum length of this (target) descriptor.

Parameters

const TDesC8 & aDesAn 8-bit non-modifiable descriptor.

operator=(const RBuf8 &)

RBuf8 &operator=(const RBuf8 &aDes)[inline]

Copies data into this descriptor replacing any existing data.

The length of this descriptor is set to reflect the new data.

A reference to this, the target descriptor.

panic

USER 11, if the length of the descriptor aDes is greater than the maximum length of this (target) descriptor.

Parameters

const RBuf8 & aDesA 8-bit buffer descriptor.

Member Data Documentation

union RBuf8::@7 @8

union RBuf8::@7@8[protected]

__DECLARE_TEST

__DECLARE_TEST[protected]

HBufC8 * iEBufCPtrType

HBufC8 *iEBufCPtrType

TUint8 * iEPtrType

TUint8 *iEPtrType