LightFileStream: Record TLightFileStream

LightFileStream

previous page next page

Record TLightFileStream

Description
Hierarchy
Nested Types
Fields
Methods
Properties

Unit

LightFileStream

Declaration

type TLightFileStream = record

Description

The sole type implemented by this unit so far.

Returns a pointer to itself from all functions to avoid unnecessary allocation or copying and to allow for a convenient "method chaining" API.

Overview

Nested Types

Published TFileState = (...);

Fields

Strict Private FFileName: PChar;
Strict Private FHandle: THandle;
Strict Private FOpen: Boolean;
Strict Private FState: TFileState;

Methods

Public function AppendAnsiChar(const Item: AnsiChar): PLightFileStream; inline;
Public function AppendAnsiString(const Item: AnsiString): PLightFileStream; inline;
Public function AppendByte(const Item: Byte): PLightFileStream; inline;
Public function AppendCurrency(const Item: Currency): PLightFileStream; inline;
Public function AppendDateTime(const Item: TDateTime): PLightFileStream; inline;
Public function AppendDouble(const Item: Double): PLightFileStream; inline;
Public function AppendExtended(const Item: Extended): PLightFileStream; inline;
Public function AppendInt64(const Item: Int64): PLightFileStream; inline;
Public function AppendLongInt(const Item: LongInt): PLightFileStream; inline;
Public function AppendLongWord(const Item: LongWord): PLightFileStream; inline;
Public function AppendPointerBuffer(const Buffer: Pointer; const NumBytesToWrite: SizeInt): PLightFileStream; inline;
Public function AppendQWord(const Item: QWord): PLightFileStream; inline;
Public function AppendShortInt(const Item: ShortInt): PLightFileStream; inline;
Public function AppendShortString(const Item: ShortString): PLightFileStream; inline;
Public function AppendSingle(const Item: Single): PLightFileStream; inline;
Public function AppendSmallInt(const Item: SmallInt): PLightFileStream; inline;
Public function AppendType<T>(constref Item: T): PLightFileStream; inline;
Public function AppendTypedBuffer<T>(constref Buffer: T; const ItemCount: SizeInt): PLightFileStream; inline;
Public function AppendUnicodeChar(const Item: UnicodeChar): PLightFileStream; inline;
Public function AppendUnicodeString(const Item: UnicodeString): PLightFileStream; inline;
Public function AppendWideChar(const Item: WideChar): PLightFileStream; inline;
Public function AppendWideString(const Item: WideString): PLightFileStream; inline;
Public function AppendWord(const Item: Word): PLightFileStream; inline;
Public function ChangeFileStateTo(const State: TFileState): PLightFileStream; inline;
Public class function Create(const FileName: PChar): TLightFileStream; static; inline;
Public function FillWith<T>(constref Value: T; const NumInstances: SizeUInt): PLightFileStream; inline;
Public function GetPosition(out ThePosition: SizeInt): PLightFileStream; inline;
Public function GetSize(out TheSize: SizeInt): PLightFileStream; inline;
Public function LogPosition: PLightFileStream; inline;
Public function LogSize: PLightFileStream; inline;
Public class function Open(const FileName: PChar; const InitialState: TFileState): TLightFileStream; static; inline;
Public function PutPosition: SizeInt; inline;
Public function PutSize: SizeInt; inline;
Public function ReadAnsiChar(var Item: AnsiChar): PLightFileStream; inline;
Public function ReadAnsiString(var Item: AnsiString; const NumChars: SizeInt): PLightFileStream; inline;
Public function ReadByte(var Item: Byte): PLightFileStream; inline;
Public function ReadCurrency(var Item: Currency): PLightFileStream; inline;
Public function ReadDateTime(var Item: TDateTime): PLightFileStream; inline;
Public function ReadDouble(var Item: Double): PLightFileStream; inline;
Public function ReadExtended(var Item: Extended): PLightFileStream; inline;
Public function ReadInt64(var Item: Int64): PLightFileStream; inline;
Public function ReadLongInt(var Item: LongInt): PLightFileStream; inline;
Public function ReadLongWord(var Item: LongWord): PLightFileStream; inline;
Public function ReadPointerBuffer(const Buffer: Pointer; const NumBytesToRead: SizeInt): PLightFileStream; inline;
Public function ReadQWord(var Item: QWord): PLightFileStream; inline;
Public function ReadShortInt(var Item: ShortInt): PLightFileStream; inline;
Public function ReadShortString(var Item: ShortString; const NumChars: SizeInt): PLightFileStream; inline;
Public function ReadSingle(var Item: Single): PLightFileStream; inline;
Public function ReadSmallInt(var Item: SmallInt): PLightFileStream; inline;
Public function ReadType<T>(var Item: T): PLightFileStream; inline;
Public function ReadTypedBuffer<T>(var Buffer: T; const ItemCount: SizeInt): PLightFileStream; inline;
Public function ReadUnicodeChar(var Item: UnicodeChar): PLightFileStream; inline;
Public function ReadUnicodeString(var Item: UnicodeString; const NumChars: SizeInt): PLightFileStream; inline;
Public function ReadWideChar(var Item: WideChar): PLightFileStream; inline;
Public function ReadWideString(var Item: WideString; const NumChars: SizeInt): PLightFileStream; inline;
Public function ReadWord(var Item: Word): PLightFileStream; inline;
Public function SeekFromBeginning(const ToPosition: SizeInt): PLightFileStream; inline;
Public function SeekFromCurrent(const ToPosition: SizeInt): PLightFileStream; inline;
Public function SeekFromEnd(const ToPosition: SizeInt): PLightFileStream; inline;
Public function Truncate: PLightFileStream; inline;
Public function WriteAnsiChar(const Item: AnsiChar): PLightFileStream; inline;
Public function WriteAnsiString(const Item: AnsiString): PLightFileStream; inline;
Public function WriteByte(const Item: Byte): PLightFileStream; inline;
Public function WriteCurrency(const Item: Currency): PLightFileStream; inline;
Public function WriteDateTime(const Item: TDateTime): PLightFileStream; inline;
Public function WriteDouble(const Item: Double): PLightFileStream; inline;
Public function WriteExtended(const Item: Extended): PLightFileStream; inline;
Public function WriteInt64(const Item: Int64): PLightFileStream; inline;
Public function WriteLongInt(const Item: LongInt): PLightFileStream; inline;
Public function WriteLongWord(const Item: LongWord): PLightFileStream; inline;
Public function WritePointerBuffer(const Buffer: Pointer; const NumBytesToWrite: SizeInt): PLightFileStream; inline;
Public function WriteQWord(const Item: QWord): PLightFileStream; inline;
Public function WriteShortInt(const Item: ShortInt): PLightFileStream; inline;
Public function WriteShortString(const Item: ShortString): PLightFileStream; inline;
Public function WriteSingle(const Item: Single): PLightFileStream; inline;
Public function WriteSmallInt(const Item: SmallInt): PLightFileStream; inline;
Public function WriteType<T>(constref Item: T): PLightFileStream; inline;
Public function WriteTypedBuffer<T>(constref Buffer: T; const ItemCount: SizeInt): PLightFileStream; inline;
Public function WriteUnicodeChar(const Item: UnicodeChar): PLightFileStream; inline;
Public function WriteUnicodeString(const Item: UnicodeString): PLightFileStream; inline;
Public function WriteWideChar(const Item: WideChar): PLightFileStream; inline;
Public function WriteWideString(const Item: WideString): PLightFileStream; inline;
Public function WriteWord(const Item: Word): PLightFileStream; inline;
Public procedure Close; inline;

Properties

Public property IsOpen: Boolean read FOpen;

Description

Nested Types

Published TFileState = (...);

Determines whether read or write operations are actively accepted.

All functions return immediately without doing anything if the current state is "wrong" relative to them, unless {$define LIGHTFILESTREAM_NOCHECKS} is set, which improves performance but is somewhat less "safe."

Values
  • fsReading
  • fsWriting

Fields

Strict Private FFileName: PChar;

The name of the underlying file on disk.

Strict Private FHandle: THandle;

The handle of the underlying file on disk.

Strict Private FOpen: Boolean;

Indicates whether the file is open and can be accessed at all.

All functions return immediately without doing anything in the event that this is false, unless {$define LIGHTFILESTREAM_NOCHECKS} is set, which improves performance but is somewhat less "safe."

Strict Private FState: TFileState;

A private instance of TFileState, used as described above.

Methods

Public function AppendAnsiChar(const Item: AnsiChar): PLightFileStream; inline;

Writes a single instance of AnsiChar from Item to the underlying file at the last position, behind any existing data.

Public function AppendAnsiString(const Item: AnsiString): PLightFileStream; inline;

Writes a single instance of AnsiString from Item to the underlying file at the last position, behind any existing data.

Public function AppendByte(const Item: Byte): PLightFileStream; inline;

Writes a single instance of Byte from Item to the underlying file at the last position, behind any existing data.

Public function AppendCurrency(const Item: Currency): PLightFileStream; inline;

Writes a single instance of Currency from Item to the underlying file at the last position, behind any existing data.

Public function AppendDateTime(const Item: TDateTime): PLightFileStream; inline;

Writes a single instance of TDateTime from Item to the underlying file at the last position, behind any existing data.

Public function AppendDouble(const Item: Double): PLightFileStream; inline;

Writes a single instance of Double from Item to the underlying file at the last position, behind any existing data.

Public function AppendExtended(const Item: Extended): PLightFileStream; inline;

Writes a single instance of Extended from Item to the underlying file at the last position, behind any existing data.

Public function AppendInt64(const Item: Int64): PLightFileStream; inline;

Writes a single instance of Int64 from Item to the underlying file at the last position, behind any existing data.

Public function AppendLongInt(const Item: LongInt): PLightFileStream; inline;

Writes a single instance of LongInt from Item to the underlying file at the last position, behind any existing data.

Public function AppendLongWord(const Item: LongWord): PLightFileStream; inline;

Writes a single instance of LongWord from Item to the underlying file at the last position, behind any existing data.

Public function AppendPointerBuffer(const Buffer: Pointer; const NumBytesToWrite: SizeInt): PLightFileStream; inline;

Assumes Buffer is pointing to something like the first value of an array of any type. Writes NumBytesToWrite bytes from it to the underlying file at the last position, behind any existing data.

Public function AppendQWord(const Item: QWord): PLightFileStream; inline;

Writes a single instance of QWord from Item to the underlying file at the last position, behind any existing data.

Public function AppendShortInt(const Item: ShortInt): PLightFileStream; inline;

Writes a single instance of ShortInt from Item to the underlying file at the last position, behind any existing data.

Public function AppendShortString(const Item: ShortString): PLightFileStream; inline;

Writes a single instance of ShortString from Item to the underlying file at the last position, behind any existing data.

Public function AppendSingle(const Item: Single): PLightFileStream; inline;

Writes a single instance of Single from Item to the underlying file at the last position, behind any existing data.

Public function AppendSmallInt(const Item: SmallInt): PLightFileStream; inline;

Writes a single instance of SmallInt from Item to the underlying file at the last position, behind any existing data.

Public function AppendType<T>(constref Item: T): PLightFileStream; inline;

Writes a single instance of T from Item to the underlying file at the last position, behind any existing data.

Public function AppendTypedBuffer<T>(constref Buffer: T; const ItemCount: SizeInt): PLightFileStream; inline;

Assumes Buffer is something like the first value of an array of T. Writes ItemCount items from it to the underlying file at the last position, behind any existing data.

Public function AppendUnicodeChar(const Item: UnicodeChar): PLightFileStream; inline;

Writes a single instance of UnicodeChar from Item to the underlying file at the last position, behind any existing data.

Public function AppendUnicodeString(const Item: UnicodeString): PLightFileStream; inline;

Writes a single instance of UnicodeString from Item to the underlying file at the last position, behind any existing data.

Public function AppendWideChar(const Item: WideChar): PLightFileStream; inline;

Writes a single instance of WideChar from Item to the underlying file at the last position, behind any existing data.

Public function AppendWideString(const Item: WideString): PLightFileStream; inline;

Writes a single instance of WideString from Item to the underlying file at the last position, behind any existing data.

Public function AppendWord(const Item: Word): PLightFileStream; inline;

Writes a single instance of Word from Item to the underlying file at the last position, behind any existing data.

Public function ChangeFileStateTo(const State: TFileState): PLightFileStream; inline;

Calls FileClose() on FHandle, then calls FileOpen() with either fmOpenRead or fmOpenWrite internally based on the provided State value. FState is then set to State.

Public class function Create(const FileName: PChar): TLightFileStream; static; inline;

Assumes FileName does not yet exist on disk. Calls FileCreate() internally. FState is then set to fsWriting, and FOpen is set to True.

Public function FillWith<T>(constref Value: T; const NumInstances: SizeUInt): PLightFileStream; inline;

Writes NumInstances instances of Value to the underlying file at the current position.

Public function GetPosition(out ThePosition: SizeInt): PLightFileStream; inline;

Returns the current position of the underlying file in ThePosition, and a self-pointer from the function itself.

Public function GetSize(out TheSize: SizeInt): PLightFileStream; inline;

Returns the size in bytes of the underlying file in TheSize, and a self-pointer from the function itself.

Public function LogPosition: PLightFileStream; inline;

Calls GetPosition() internally and displays the value with WriteLn().

Public function LogSize: PLightFileStream; inline;

Calls GetSize() internally and displays the value with WriteLn().

Public class function Open(const FileName: PChar; const InitialState: TFileState): TLightFileStream; static; inline;

Assumes FileName already exists on disk. Calls FileOpen() with either fmOpenRead or fmOpenWrite internally based on the provided InitialState value.

FState is then set to InitialState, and FOpen is set to True.

Public function PutPosition: SizeInt; inline;

Returns the current position of the underlying file.

Public function PutSize: SizeInt; inline;

Returns the size in bytes of the underlying file.

Public function ReadAnsiChar(var Item: AnsiChar): PLightFileStream; inline;

Reads a single instance of AnsiChar into Item from the underlying file at the current position.

Public function ReadAnsiString(var Item: AnsiString; const NumChars: SizeInt): PLightFileStream; inline;

Reads NumChars worth of AnsiChars into Item from the underlying file at the current position.

Public function ReadByte(var Item: Byte): PLightFileStream; inline;

Reads a single instance of Byte into Item from the underlying file at the current position.

Public function ReadCurrency(var Item: Currency): PLightFileStream; inline;

Reads a single instance of Currency into Item from the underlying file at the current position.

Public function ReadDateTime(var Item: TDateTime): PLightFileStream; inline;

Reads a single instance of TDateTime into Item from the underlying file at the current position.

Public function ReadDouble(var Item: Double): PLightFileStream; inline;

Reads a single instance of Double into Item from the underlying file at the current position.

Public function ReadExtended(var Item: Extended): PLightFileStream; inline;

Reads a single instance of Extended into Item from the underlying file at the current position.

Public function ReadInt64(var Item: Int64): PLightFileStream; inline;

Reads a single instance of Int64 into Item from the underlying file at the current position.

Public function ReadLongInt(var Item: LongInt): PLightFileStream; inline;

Reads a single instance of LongInt into Item from the underlying file at the current position.

Public function ReadLongWord(var Item: LongWord): PLightFileStream; inline;

Reads a single instance of LongWord into Item from the underlying file at the current position.

Public function ReadPointerBuffer(const Buffer: Pointer; const NumBytesToRead: SizeInt): PLightFileStream; inline;

Assumes Buffer is pointing to something like the first value of an array of any type. Reads NumBytesToRead bytes into it from the underlying file at the current position.

Public function ReadQWord(var Item: QWord): PLightFileStream; inline;

Reads a single instance of QWord into Item from the underlying file at the current position.

Public function ReadShortInt(var Item: ShortInt): PLightFileStream; inline;

Reads a single instance of ShortInt into Item from the underlying file at the current position.

Public function ReadShortString(var Item: ShortString; const NumChars: SizeInt): PLightFileStream; inline;

Reads NumChars worth of AnsiChars into Item from the underlying file at the current position.

Public function ReadSingle(var Item: Single): PLightFileStream; inline;

Reads a single instance of Single into Item from the underlying file at the current position.

Public function ReadSmallInt(var Item: SmallInt): PLightFileStream; inline;

Reads a single instance of SmallInt into Item from the underlying file at the current position.

Public function ReadType<T>(var Item: T): PLightFileStream; inline;

Reads a single instance of T into Item from the underlying file at the current position.

Public function ReadTypedBuffer<T>(var Buffer: T; const ItemCount: SizeInt): PLightFileStream; inline;

Assumes Buffer is something like the first value of an array of T. Reads ItemCount items into it from the underlying file at the current position.

Public function ReadUnicodeChar(var Item: UnicodeChar): PLightFileStream; inline;

Reads a single instance of UnicodeChar into Item from the underlying file at the current position.

Public function ReadUnicodeString(var Item: UnicodeString; const NumChars: SizeInt): PLightFileStream; inline;

Reads NumChars worth of UnicodeChars into Item from the underlying file at the current position.

Public function ReadWideChar(var Item: WideChar): PLightFileStream; inline;

Reads a single instance of WideChar into Item from the underlying file at the current position.

Public function ReadWideString(var Item: WideString; const NumChars: SizeInt): PLightFileStream; inline;

Reads NumChars worth of WideChars into Item from the underlying file at the current position.

Public function ReadWord(var Item: Word): PLightFileStream; inline;

Reads a single instance of Word into Item from the underlying file at the current position.

Public function SeekFromBeginning(const ToPosition: SizeInt): PLightFileStream; inline;

Sets the current position of the underlying file to ToPosition, relative to 0.

Public function SeekFromCurrent(const ToPosition: SizeInt): PLightFileStream; inline;

Sets the current position of the underlying file to ToPosition, relative to itself.

Public function SeekFromEnd(const ToPosition: SizeInt): PLightFileStream; inline;

Sets the current position of the underlying file to ToPosition, relative to the end of the file.

Public function Truncate: PLightFileStream; inline;

Truncates the underlying file at the current position.

Public function WriteAnsiChar(const Item: AnsiChar): PLightFileStream; inline;

Writes a single instance of AnsiChar from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteAnsiString(const Item: AnsiString): PLightFileStream; inline;

Writes a single instance of AnsiString from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteByte(const Item: Byte): PLightFileStream; inline;

Writes a single instance of Byte from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteCurrency(const Item: Currency): PLightFileStream; inline;

Writes a single instance of Currency from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteDateTime(const Item: TDateTime): PLightFileStream; inline;

Writes a single instance of TDateTime from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteDouble(const Item: Double): PLightFileStream; inline;

Writes a single instance of Double from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteExtended(const Item: Extended): PLightFileStream; inline;

Writes a single instance of Extended from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteInt64(const Item: Int64): PLightFileStream; inline;

Writes a single instance of Int64 from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteLongInt(const Item: LongInt): PLightFileStream; inline;

Writes a single instance of LongInt from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteLongWord(const Item: LongWord): PLightFileStream; inline;

Writes a single instance of LongWord from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WritePointerBuffer(const Buffer: Pointer; const NumBytesToWrite: SizeInt): PLightFileStream; inline;

Assumes Buffer is pointing to something like the first value of an array of any type.

Writes NumBytesToWrite bytes from it to the underlying file at the current position, possibly overwriting existing data.

Public function WriteQWord(const Item: QWord): PLightFileStream; inline;

Writes a single instance of QWord from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteShortInt(const Item: ShortInt): PLightFileStream; inline;

Writes a single instance of ShortInt from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteShortString(const Item: ShortString): PLightFileStream; inline;

Writes a single instance of ShortString from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteSingle(const Item: Single): PLightFileStream; inline;

Writes a single instance of Single from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteSmallInt(const Item: SmallInt): PLightFileStream; inline;

Writes a single instance of SmallInt from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteType<T>(constref Item: T): PLightFileStream; inline;

Writes a single instance of T from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteTypedBuffer<T>(constref Buffer: T; const ItemCount: SizeInt): PLightFileStream; inline;

Assumes Buffer is something like the first value of an array of T. Writes ItemCount items from it to the underlying file at the current position, possibly overwriting existing data.

Public function WriteUnicodeChar(const Item: UnicodeChar): PLightFileStream; inline;

Writes a single instance of UnicodeChar from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteUnicodeString(const Item: UnicodeString): PLightFileStream; inline;

Writes a single instance of UnicodeString from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteWideChar(const Item: WideChar): PLightFileStream; inline;

Writes a single instance of WideChar from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteWideString(const Item: WideString): PLightFileStream; inline;

Writes a single instance of WideString from Item to the underlying file at the current position, possibly overwriting existing data.

Public function WriteWord(const Item: Word): PLightFileStream; inline;

Writes a single instance of Word from Item to the underlying file at the current position, possibly overwriting existing data.

Public procedure Close; inline;

Closes the underlying file. Does not return a self-pointer, as it should always be the last method called.

Properties

Public property IsOpen: Boolean read FOpen;

Indicates directly whether or not the underlying file is open.

Generated by PasDoc 0.15.0.
previous page start next page