Skip to content

TCachedDataStream

Base cached stream class

Declaration

Source position: resdatastream.pp line 32

type

  TCachedDataStream = class(TStream)
  protected
    fStream: type

      TStream = class(TObject)
        procedure InvalidSeek;
        procedure Discard;
        procedure DiscardLarge;
        procedure FakeSeekForward;
        procedure GetPosition;
        procedure SetPosition;
        procedure GetSize;
        procedure SetSize64;
        procedure SetSize;
        procedure ReadNotImplemented;
        procedure WriteNotImplemented;
        procedure ReadMaxSizeData;
        procedure ReadExactSizeData;
        procedure WriteMaxSizeData;
        procedure WriteExactSizeData;
        procedure DefaultWriteUnitname;
        procedure Read;
        procedure Read64;
        procedure Write;
        procedure Write64;
        procedure Seek;
        procedure ReadData;
        procedure ReadBuffer;
        procedure ReadBufferData;
        procedure WriteBuffer;
        procedure WriteData;
        procedure WriteBufferData;
        procedure CopyFrom;
        procedure ReadComponent;
        procedure ReadComponentRes;
        procedure WriteComponent;
        procedure WriteComponentRes;
        procedure WriteDescendent;
        procedure WriteDescendentRes;
        procedure WriteResourceHeader;
        procedure FixupResourceHeader;
        procedure ReadResHeader;
        procedure ReadByte;
        procedure ReadWord;
        procedure ReadDWord;
        procedure ReadQWord;
        procedure ReadAnsiString;
        procedure ReadUnicodeString;
        procedure WriteByte;
        procedure WriteWord;
        procedure WriteDWord;
        procedure WriteQWord;
        procedure WriteAnsiString;
        procedure WriteUnicodeString;
        property Position; {rw}
        property Size; {rw}
      end;
    var
      fSize: Int64;
      fPosition: Int64;
    function GetPosition : Int64;
    procedure SetPosition;
    function GetSize : Int64;
    procedure SetSize64;
  public
    constructor Create;
    function Write : LongInt;
    function Seek : Int64;
  end;

Description

This abstract class provides basic cached stream functionalities.

A cached stream is a read-only stream that operates on a portion of another stream. That is, it creates a "window" on the original stream from which to read data. Since it is a read-only stream, trying to write to the stream or to set its size cause an EInvalidOperation exception to be raised.

This class is used by TResourceDataStream to access the raw data of a resource. When an attempt to write to the stream is detected, TResourceDataStream replaces it with a memory stream and copies the contents of the cached stream to the memory one, thus providing a copy-on-write mechanism.

Remark:

An object of this class should never be directly instantiated: use a descendant class instead.

Methods

Member Visibility Description
Create public Creates a new object
GetPosition protected
GetSize protected
Seek public
SetPosition protected
SetSize64 protected
Write public
See all Methods

Fieldss

Member Visibility Description
fPosition protected The position from the cached stream perspective
fSize protected The size of the cached stream
fStream protected The original stream
See all Fieldss

See also

Name Description
TResourceDataStream Stream class that provides copy-on-write functionality
TCachedResourceDataStream An implementation of a cached stream