Interface CompactWriter

Provides means of writing compact serialized fields to the binary data.

Hierarchy

CompactWriter

Methods

writeArrayOfBoolean

writeArrayOfBoolean(fieldName: string, value: boolean[]): void
Writes an array of booleans.
Parameters
- fieldName: string
  
  name of the field.
- value: boolean[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:143

writeArrayOfCompact

writeArrayOfCompact<T>(fieldName: string, value: T[]): void
Writes an array of nested compact objects.

For compact objects, if an array contains different item types or undefined a HazelcastSerializationError will be thrown.
Type Parameters
- T
Parameters
- fieldName: string
  
  name of the field.
- value: T[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:250

writeArrayOfDate

writeArrayOfDate(fieldName: string, value: LocalDate[]): void
Writes an array of LocalDate.
Parameters
- fieldName: string
  
  name of the field.
- value: LocalDate[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:223

writeArrayOfDecimal

writeArrayOfDecimal(fieldName: string, value: BigDecimal[]): void
Writes an array of BigDecimal.
Parameters
- fieldName: string
  
  name of the field.
- value: BigDecimal[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:207

writeArrayOfFloat32

writeArrayOfFloat32(fieldName: string, value: number[]): void
Writes an array of 32-bit IEEE 754 floating point numbers.
Parameters
- fieldName: string
  
  name of the field.
- value: number[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:183

writeArrayOfFloat64

writeArrayOfFloat64(fieldName: string, value: number[]): void
Writes an array of 64-bit IEEE 754 floating point numbers.
Parameters
- fieldName: string
  
  name of the field.
- value: number[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:191

writeArrayOfInt16

writeArrayOfInt16(fieldName: string, value: number[]): void
Writes an array of 16-bit two's complement signed integers.
Parameters
- fieldName: string
  
  name of the field.
- value: number[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:159

writeArrayOfInt32

writeArrayOfInt32(fieldName: string, value: number[]): void
Writes an array of 32-bit two's complement signed integers.
Parameters
- fieldName: string
  
  name of the field.
- value: number[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:167

writeArrayOfInt64

writeArrayOfInt64(fieldName: string, value: Long[]): void
Writes an array of 64-bit two's complement signed integers (Long objects).
Parameters
- fieldName: string
  
  name of the field.
- value: Long[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:175

writeArrayOfInt8

writeArrayOfInt8(fieldName: string, value: Buffer): void
Writes an array of 8-bit two's complement signed integers.
Parameters
- fieldName: string
  
  name of the field.
- value: Buffer
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:151

writeArrayOfNullableBoolean

writeArrayOfNullableBoolean(fieldName: string, value: boolean[]): void
Writes a nullable array of nullable booleans.
Parameters
- fieldName: string
  
  name of the field.
- value: boolean[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:314

writeArrayOfNullableFloat32

writeArrayOfNullableFloat32(fieldName: string, value: number[]): void
Writes a nullable array of nullable 32-bit IEEE 754 floating point numbers.
Parameters
- fieldName: string
  
  name of the field.
- value: number[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:354

writeArrayOfNullableFloat64

writeArrayOfNullableFloat64(fieldName: string, value: number[]): void
Writes a nullable array of nullable 64-bit IEEE 754 floating point numbers.
Parameters
- fieldName: string
  
  name of the field.
- value: number[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:362

writeArrayOfNullableInt16

writeArrayOfNullableInt16(fieldName: string, value: number[]): void
Writes a nullable array of nullable 16-bit two's complement signed integers.
Parameters
- fieldName: string
  
  name of the field.
- value: number[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:330

writeArrayOfNullableInt32

writeArrayOfNullableInt32(fieldName: string, value: number[]): void
Writes a nullable array of nullable 32-bit two's complement signed integers.
Parameters
- fieldName: string
  
  name of the field.
- value: number[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:338

writeArrayOfNullableInt64

writeArrayOfNullableInt64(fieldName: string, value: Long[]): void
Writes a nullable array of nullable 64-bit two's complement signed integers (Long objects).
Parameters
- fieldName: string
  
  name of the field.
- value: Long[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:346

writeArrayOfNullableInt8

writeArrayOfNullableInt8(fieldName: string, value: number[]): void
Writes a nullable array of nullable 8-bit two's complement signed integers.
Parameters
- fieldName: string
  
  name of the field.
- value: number[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:322

writeArrayOfString

writeArrayOfString(fieldName: string, value: string[]): void
Writes an array of UTF-8 encoded strings.
Parameters
- fieldName: string
  
  name of the field.
- value: string[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:199

writeArrayOfTime

writeArrayOfTime(fieldName: string, value: LocalTime[]): void
Writes an array of LocalTime.
Parameters
- fieldName: string
  
  name of the field.
- value: LocalTime[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:215

writeArrayOfTimestamp

writeArrayOfTimestamp(fieldName: string, value: LocalDateTime[]): void
Writes an array of LocalDateTime.
Parameters
- fieldName: string
  
  name of the field.
- value: LocalDateTime[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:231

writeArrayOfTimestampWithTimezone

writeArrayOfTimestampWithTimezone(fieldName: string, value: OffsetDateTime[]): void
Writes an array of OffsetDateTime.
Parameters
- fieldName: string
  
  name of the field.
- value: OffsetDateTime[]
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:239

writeBoolean

writeBoolean(fieldName: string, value: boolean): void
Writes a boolean.
Parameters
- fieldName: string
  
  name of the field.
- value: boolean
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:31

writeCompact

writeCompact<T>(fieldName: string, value: T): void
Writes a nested compact object.
Type Parameters
- T
Parameters
- fieldName: string
  
  name of the field.
- value: T
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:135

writeDate

writeDate(fieldName: string, value: LocalDate): void
Writes a LocalDate.
Parameters
- fieldName: string
  
  name of the field.
- value: LocalDate
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:111

writeDecimal

writeDecimal(fieldName: string, value: BigDecimal): void
Writes a BigDecimal
Parameters
- fieldName: string
  
  name of the field.
- value: BigDecimal
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:95

writeFloat32

writeFloat32(fieldName: string, value: number): void
Writes a 32-bit IEEE 754 floating point number.
Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:71

writeFloat64

writeFloat64(fieldName: string, value: number): void
Writes a 64-bit IEEE 754 floating point number.
Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:79

writeInt16

writeInt16(fieldName: string, value: number): void
Writes a 16-bit two's complement signed integer.
Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:47

writeInt32

writeInt32(fieldName: string, value: number): void
Writes a 32-bit two's complement signed integer.
Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:55

writeInt64

writeInt64(fieldName: string, value: Long): void
Writes a 64-bit two's complement signed integer (a Long object).
Parameters
- fieldName: string
  
  name of the field.
- value: Long
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:63

writeInt8

writeInt8(fieldName: string, value: number): void
Writes an 8-bit two's complement signed integer.
Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:39

writeNullableBoolean

writeNullableBoolean(fieldName: string, value: boolean): void
Writes a nullable boolean.
Parameters
- fieldName: string
  
  name of the field.
- value: boolean
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:258

writeNullableFloat32

writeNullableFloat32(fieldName: string, value: number): void
Writes a nullable 32-bit IEEE 754 floating point number.
Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:298

writeNullableFloat64

writeNullableFloat64(fieldName: string, value: number): void
Writes a nullable 64-bit IEEE 754 floating point number.
Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:306

writeNullableInt16

writeNullableInt16(fieldName: string, value: number): void
Writes a nullable 16-bit two's complement signed integer.
Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:274

writeNullableInt32

writeNullableInt32(fieldName: string, value: number): void
Writes a nullable 32-bit two's complement signed integer.
Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:282

writeNullableInt64

writeNullableInt64(fieldName: string, value: Long): void
Writes a nullable 64-bit two's complement signed integer (a Long object).
Parameters
- fieldName: string
  
  name of the field.
- value: Long
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:290

writeNullableInt8

writeNullableInt8(fieldName: string, value: number): void
Writes a nullable 8-bit two's complement signed integer.
Parameters
- fieldName: string
  
  name of the field.
- value: number
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:266

writeString

writeString(fieldName: string, value: string): void
Writes an UTF-8 encoded string.
Parameters
- fieldName: string
  
  name of the field.
- value: string
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:87

writeTime

writeTime(fieldName: string, value: LocalTime): void
Writes a LocalTime.
Parameters
- fieldName: string
  
  name of the field.
- value: LocalTime
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:103

writeTimestamp

writeTimestamp(fieldName: string, value: LocalDateTime): void
Writes a LocalDateTime.
Parameters
- fieldName: string
  
  name of the field.
- value: LocalDateTime
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:119

writeTimestampWithTimezone

writeTimestampWithTimezone(fieldName: string, value: OffsetDateTime): void
Reads a OffsetDateTime.
Parameters
- fieldName: string
  
  name of the field.
- value: OffsetDateTime
  
  to be written.
Returns void
- Defined in src/serialization/compact/CompactWriter.ts:127

Generated using TypeDoc