Brook Tardigrade

Class TBrookTextReader

Description
Hierarchy
Fields
Methods
Properties

Unit

BrookReader

Declaration

type TBrookTextReader = class abstract(TObject)

Description

Abstract class for line reader.

Hierarchy

Overview

Methods

Public procedure Reset; virtual; abstract;
Public procedure Close; virtual; abstract;
Public function IsEOF: Boolean; virtual; abstract;
Public procedure ReadBytes(out ALine: TBytes); overload; virtual; abstract;
Public function ReadBytes: TBytes; overload; virtual; abstract;
Public procedure Read(out ALine: string); overload; virtual; abstract;
Public function Read: string; overload; virtual; abstract;

Properties

Public property EOF: Boolean read IsEOF;
Public property Encoding: TEncoding read GetEncoding write SetEncoding;

Description

Methods

Public procedure Reset; virtual; abstract;

Resets the reader to its initial state.

Public procedure Close; virtual; abstract;

Closes the reader.

Public function IsEOF: Boolean; virtual; abstract;

Checks if the reader has reached the End-Of-File.

Returns

True if the reader has reached the End-Of-File.

Public procedure ReadBytes(out ALine: TBytes); overload; virtual; abstract;

Reads a line as bytes.

Parameters
ALine[out]
Line read as bytes.
Public function ReadBytes: TBytes; overload; virtual; abstract;

Reads a line returning it as bytes.

Returns

Line read as bytes.

Public procedure Read(out ALine: string); overload; virtual; abstract;

Reads a line as static string.

Parameters
ALine[out]
read as static string.
Public function Read: string; overload; virtual; abstract;

Read a line returning it as a static string.

Returns

Line read as static string.

Properties

Public property EOF: Boolean read IsEOF;

True if the reader has reached the End-Of-File.

Public property Encoding: TEncoding read GetEncoding write SetEncoding;

Character encoding determined during reading.

Generated by PasDoc 0.16.0.