RReadStream Class Reference

class RReadStream

The read stream interface. The process of internalising from a stream is achieved through a reference to an object of this type.

A store aware class defines an implements an InternalizeL() member function which is used to internalise that object and takes a reference to an RReadStream as the interface to the read stream.

Public Member Functions
RReadStream()
RReadStream(MStreamBuf *)
voidClose()
voidPop()
IMPORT_C voidPushL()
IMPORT_C TInt16ReadInt16L()
IMPORT_C TInt32ReadInt32L()
IMPORT_C TInt8ReadInt8L()
IMPORT_C voidReadL(TDes8 &)
IMPORT_C voidReadL(TDes8 &, TInt)
IMPORT_C voidReadL(TDes8 &, TChar)
IMPORT_C voidReadL(TUint8 *, TInt)
IMPORT_C voidReadL(TInt)
voidReadL(RWriteStream &)
voidReadL(RWriteStream &, TInt)
IMPORT_C voidReadL(TDes16 &)
IMPORT_C voidReadL(TDes16 &, TInt)
IMPORT_C voidReadL(TDes16 &, TChar)
IMPORT_C voidReadL(TUint16 *, TInt)
IMPORT_C TReal32ReadReal32L()
IMPORT_C TReal64ReadReal64L()
IMPORT_C TUint16ReadUint16L()
IMPORT_C TUint32ReadUint32L()
IMPORT_C TUint8ReadUint8L()
IMPORT_C voidRelease()
MStreamBuf *Source()
Protected Member Functions
voidAttach(MStreamBuf *)
voidDetach()
Private Attributes
MStreamBuf *iSrc

Constructor & Destructor Documentation

RReadStream()

RReadStream()[inline]

Sets the stream buffer source to NULL, which implies that it is safe to close

RReadStream::Source()

RReadStream(MStreamBuf *)

RReadStream(MStreamBuf *aSource)[inline]

Constructs a read stream over the supplied stream buffer.

RReadStream::Source()

Parameters

MStreamBuf * aSourceThe stream buffer used to read from the read stream.

Member Functions Documentation

Attach(MStreamBuf *)

voidAttach(MStreamBuf *aSource)[protected, inline]

Sets the stream buffer source for this read stream. The existing source (if there is one) will be discarded.

This is useful for derived classes, enabling them to set the source following construction.

Note:

Release() is not called on any discarded stream buffer.

RReadStream::Source()

RReadStream::Detach()

Parameters

MStreamBuf * aSourceThe new source stream buffer for this read stream.

Close()

voidClose()[inline]

Frees resources used by the stream.

RReadStream::Release()

Detach()

voidDetach()[protected, inline]

Sets the stream buffer source for this read stream to NULL. The existing source, if there is one, will be discarded.

Note that Release() is not called on any discarded stream buffer.

RReadStream::Source()

RReadStream::Attach()

Pop()

voidPop()[inline]

Removes the cleanup item for this read stream object from the cleanup stack.

PushL()

IMPORT_C voidPushL()

ReadInt16L()

IMPORT_C TInt16ReadInt16L()

ReadInt32L()

IMPORT_C TInt32ReadInt32L()

ReadInt8L()

IMPORT_C TInt8ReadInt8L()

ReadL(TDes8 &)

IMPORT_C voidReadL(TDes8 &aDes)

Parameters

TDes8 & aDes

ReadL(TDes8 &, TInt)

IMPORT_C voidReadL(TDes8 &aDes,
TIntaLength
)

Parameters

TDes8 & aDes
TInt aLength

ReadL(TDes8 &, TChar)

IMPORT_C voidReadL(TDes8 &aDes,
TCharaDelim
)

Parameters

TDes8 & aDes
TChar aDelim

ReadL(TUint8 *, TInt)

IMPORT_C voidReadL(TUint8 *aPtr,
TIntaLength
)

Parameters

TUint8 * aPtr
TInt aLength

ReadL(TInt)

IMPORT_C voidReadL(TIntaLength)

Parameters

TInt aLength

ReadL(RWriteStream &)

voidReadL(RWriteStream &aStream)[inline]

Writes the content of this stream to the specified write stream.

Parameters

RWriteStream & aStreamA reference to the write stream to which this stream is to be written.

ReadL(RWriteStream &, TInt)

voidReadL(RWriteStream &aStream,
TIntaLength
)[inline]

Writes the content of this stream to the specified write stream.

Parameters

RWriteStream & aStreamA reference to the write stream to which this stream is to be written.
TInt aLengthThe length of data from this stream to be written to aStream.

ReadL(TDes16 &)

IMPORT_C voidReadL(TDes16 &aDes)

Parameters

TDes16 & aDes

ReadL(TDes16 &, TInt)

IMPORT_C voidReadL(TDes16 &aDes,
TIntaLength
)

Parameters

TDes16 & aDes
TInt aLength

ReadL(TDes16 &, TChar)

IMPORT_C voidReadL(TDes16 &aDes,
TCharaDelim
)

Parameters

TDes16 & aDes
TChar aDelim

ReadL(TUint16 *, TInt)

IMPORT_C voidReadL(TUint16 *aPtr,
TIntaLength
)

Parameters

TUint16 * aPtr
TInt aLength

ReadReal32L()

IMPORT_C TReal32ReadReal32L()

ReadReal64L()

IMPORT_C TReal64ReadReal64L()

ReadUint16L()

IMPORT_C TUint16ReadUint16L()

ReadUint32L()

IMPORT_C TUint32ReadUint32L()

ReadUint8L()

IMPORT_C TUint8ReadUint8L()

Release()

IMPORT_C voidRelease()

Source()

MStreamBuf *Source()[inline]

Gets the underlying stream buffer for the read stream. This provides access to the stream-buffer implementation used by the read stream.

Note:

If the stream buffer supports seeking, this allows the RReadStream client to have random access to the stream data.

The underlying stream buffer for the read stream.

RReadStream::Attach()

RReadStream::Detach()

Member Data Documentation

MStreamBuf * iSrc

MStreamBuf *iSrc[private]