Class BitReader

Class for reading bit strings

Constructors

constructor

new BitReader(bits: BitString, offset?: number): BitReader
Parameters
- bits: BitString
- Optionaloffset: number
Returns BitReader
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:19

Accessors

offset

get offset(): number
Offset in source bit string

Returns number
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:23

remaining

get remaining(): number
Number of bits remaining

Returns number
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:27

Methods

clone

clone(): BitReader
Clone BitReader

Returns BitReader
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:214

loadAddress

loadAddress(): Address
Load Address

Returns Address
Address
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:185

loadAddressAny

loadAddressAny(): null | Address | ExternalAddress
Read address of any type

Returns null | Address | ExternalAddress
Address or ExternalAddress or null
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:205

loadBit

loadBit(): boolean
Load a single bit

Returns boolean
true if the bit is set, false otherwise
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:45

loadBits

loadBits(bits: number): BitString
Load bit string
Parameters
- bits: number
  number of bits to read
Returns BitString
new bitstring
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:56

loadBuffer

loadBuffer(bytes: number): Buffer
Load buffer
Parameters
- bytes: number
  number of bytes
Returns Buffer
new buffer
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:68

loadCoins

loadCoins(): bigint
Load coins value

Returns bigint
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:175

loadExternalAddress

loadExternalAddress(): ExternalAddress
Load external address

Returns ExternalAddress
ExternalAddress
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:195

loadInt

loadInt(bits: number): number
Load int value
Parameters
- bits: number
  int bits
Returns number
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:104

loadIntBig

loadIntBig(bits: number): bigint
Load int value as bigint
Parameters
- bits: number
  int bits
Returns bigint
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:110

loadMaybeAddress

loadMaybeAddress(): null | Address
Load internal address

Returns null | Address
Address or null
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:190

loadMaybeExternalAddress

loadMaybeExternalAddress(): null | ExternalAddress
Load external address

Returns null | ExternalAddress
ExternalAddress or null
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:200

loadPaddedBits

loadPaddedBits(bits: number): BitString
Load bit string that was padded to make it byte alligned. Used in BOC serialization
Parameters
- bits: number
Returns BitString
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:210

loadUint

loadUint(bits: number): number
Load uint value
Parameters
- bits: number
  uint bits
Returns number
read value as number
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:80

loadUintBig

loadUintBig(bits: number): bigint
Load uint value as bigint
Parameters
- bits: number
  uint bits
Returns bigint
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:86

loadVarInt

loadVarInt(bits: number): number
Load varint value
Parameters
- bits: number
  number of bits to read the size
Returns number
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:152

loadVarIntBig

loadVarIntBig(bits: number): bigint
Load varint value
Parameters
- bits: number
  number of bits to read the size
Returns bigint
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:158

loadVarUint

loadVarUint(bits: number): number
Load varuint value
Parameters
- bits: number
  number of bits to read the size
Returns number
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:128

loadVarUintBig

loadVarUintBig(bits: number): bigint
Load varuint value
Parameters
- bits: number
  number of bits to read the size
Returns bigint
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:134

preloadBit

preloadBit(): boolean
Preload bit

Returns boolean
true if the bit is set, false otherwise
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:50

preloadBits

preloadBits(bits: number): BitString
Preload bit string
Parameters
- bits: number
  number of bits to read
Returns BitString
new bitstring
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:62

preloadBuffer

preloadBuffer(bytes: number): Buffer
Preload buffer
Parameters
- bytes: number
  number of bytes
Returns Buffer
new buffer
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:74

preloadCoins

preloadCoins(): bigint
Preload coins value

Returns bigint
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:180

preloadInt

preloadInt(bits: number): number
Preload int value
Parameters
- bits: number
  int bits
Returns number
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:116

preloadIntBig

preloadIntBig(bits: number): bigint
Preload int value
Parameters
- bits: number
  int bits
Returns bigint
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:122

preloadUint

preloadUint(bits: number): number
Preload uint value
Parameters
- bits: number
  uint bits
Returns number
read value as number
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:92

preloadUintBig

preloadUintBig(bits: number): bigint
Preload uint value as bigint
Parameters
- bits: number
  uint bits
Returns bigint
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:98

preloadVarInt

preloadVarInt(bits: number): number
Preload varint value
Parameters
- bits: number
  number of bits to read the size
Returns number
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:164

preloadVarIntBig

preloadVarIntBig(bits: number): bigint
Preload varint value
Parameters
- bits: number
  number of bits to read the size
Returns bigint
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:170

preloadVarUint

preloadVarUint(bits: number): number
Preload varuint value
Parameters
- bits: number
  number of bits to read the size
Returns number
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:140

preloadVarUintBig

preloadVarUintBig(bits: number): bigint
Preload varuint value
Parameters
- bits: number
  number of bits to read the size
Returns bigint
read value as bigint
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:146

reset

reset(): void
Reset to the beginning or latest checkpoint

Returns void
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:36

save

save(): void
Save checkpoint

Returns void
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:40

skip

skip(bits: number): void
Skip bits
Parameters
- bits: number
  number of bits to skip
Returns void
- Defined in node_modules/@ton/core/dist/boc/BitReader.d.ts:32