Class TEoWriter

Description

Hierarchy

Fields

Methods

Properties

Unit

EOLib.Data

Declaration

type TEoWriter = class(TObject)

Description

A class for writing EO data to a sequence of bytes.

Hierarchy

TObject
TEoWriter

Overview

Methods

	`constructor Create;`
	`procedure AddByte(Value: Cardinal);`
	`procedure AddBytes(const Bytes: TArray<Byte>);`
	`procedure AddChar(Number: Cardinal);`
	`procedure AddShort(Number: Cardinal);`
	`procedure AddThree(Number: Cardinal);`
	`procedure AddInt(Number: Cardinal);`
	`procedure AddString(Str: string);`
	`procedure AddFixedString(Str: string; ExpectedLength: Cardinal; Padded: Boolean = False); overload;`
	`procedure AddEncodedString(Str: string);`
	`procedure AddFixedEncodedString(Str: string; ExpectedLength: Cardinal; Padded: Boolean = False); overload;`
	`function ToByteArray: TArray<Byte>;`

Properties

	`property StringSanitizationMode: Boolean read FStringSanitizationMode write FStringSanitizationMode;`
	`property Length: Cardinal read FLength;`

Description

Methods

	`constructor Create;`
Creates a new `TEoWriter` instance with no data.

procedure AddByte(Value: Cardinal);

Adds a raw byte to the writer data.

Parameters

Value: The byte to be added

Exceptions raised

EArgumentException: If the value is above $FF

procedure AddBytes(const Bytes: TArray<Byte>);

Adds an array of raw bytes to the writer data.

Parameters

Bytes: The array of bytes to be added

procedure AddChar(Number: Cardinal);

Adds an encoded 1-byte integer to the writer data.

Parameters

Number: The number to be encoded and added

Exceptions raised

EArgumentException: If the value is above EoCharMax

procedure AddShort(Number: Cardinal);

Adds an encoded 2-byte integer to the writer data.

Parameters

Number: The number to be encoded and added

Exceptions raised

EArgumentException: If the value is above EoShortMax

procedure AddThree(Number: Cardinal);

Adds an encoded 3-byte integer to the writer data.

Parameters

Number: The number to be encoded and added

Exceptions raised

EArgumentException: If the value is above EoThreeMax

procedure AddInt(Number: Cardinal);

Adds an encoded 4-byte integer to the writer data.

Parameters

Number: The number to be encoded and added

Exceptions raised

EArgumentException: If the value is above EoIntMax

procedure AddString(Str: string);

Adds a string to the writer data.

Parameters

Str: The string to be added

procedure AddFixedString(Str: string; ExpectedLength: Cardinal; Padded: Boolean = False); overload;

Adds a fixed-length string to the writer data.

Parameters

Str: The string to be added
Length: The expected length of the string
Padded: True if Str should be padded to Length with trailing $FF bytes

Exceptions raised

EArgumentException: If the string does not have the expected length

procedure AddEncodedString(Str: string);

Adds an encoded string to the writer data.

Parameters

Str: The string to be encoded and added

procedure AddFixedEncodedString(Str: string; ExpectedLength: Cardinal; Padded: Boolean = False); overload;

Adds a fixed-length encoded string to the writer data.

Parameters

Str: The string to be encoded and added
Length: The expected length of the string
Padded: True if Str should be padded to Length with trailing $FF bytes

Exceptions raised

EArgumentException: If the string does not have the expected length

function ToByteArray: TArray<Byte>;

Gets the writer data as a byte array.

Returns

A copy of the writer data as a byte array

Properties

property StringSanitizationMode: Boolean read FStringSanitizationMode write FStringSanitizationMode;

If string sanitization mode is enabled, the writer will switch $FF (ÿ) bytes in strings to $79 (y).

See:

Chunked Reading: Sanitization

	`property Length: Cardinal read FLength;`
The length of the writer data.

Generated by PasDoc 0.16.0-snapshot.