Class Slice

Slice is a class that allows to read cell data

Hierarchy

Slice

Constructors

constructor

new Slice(reader: BitReader, refs: Cell[]): Slice
Parameters
- reader: BitReader
- refs: Cell[]
Returns Slice
- Defined in src/boc/Slice.ts:15

Properties

`Private` _reader

_reader: BitReader

`Private` _refs

_refs: Cell[]

Accessors

remainingBits

get remainingBits(): number
Get remaining bits

Returns number
- Defined in src/boc/Slice.ts:23

remainingRefs

get remainingRefs(): number
Get remaining refs

Returns number
- Defined in src/boc/Slice.ts:30

Methods

[SymbolInspect]

[SymbolInspect](): string
Returns string
- Defined in src/boc/Slice.ts:526

asBuilder

asBuilder(): Builder
Returns

Returns Builder
- Defined in src/boc/Slice.ts:506

asCell

asCell(): Cell
Convert slice to cell

Returns Cell
- Defined in src/boc/Slice.ts:498

clone

clone(): Slice
Clone slice

Returns
cloned slice

Returns Slice
- Defined in src/boc/Slice.ts:514

endParse

endParse(): void
Checks if slice is empty

Returns void
- Defined in src/boc/Slice.ts:489

loadAddress

loadAddress(): Address
Load internal Address

Returns
Address

Returns Address
- Defined in src/boc/Slice.ts:326

loadAddressAny

loadAddressAny(): null | Address | ExternalAddress
Load address

Returns
Address, ExternalAddress or null

Returns null | Address | ExternalAddress
- Defined in src/boc/Slice.ts:358

loadBit

loadBit(): boolean
Load a single bit

Returns
true or false depending on the bit value

Returns boolean
- Defined in src/boc/Slice.ts:47

loadBits

loadBits(bits: number): BitString
Load bits as a new BitString

Returns
new BitString
Parameters
- bits: number
  
  number of bits to read
Returns BitString
- Defined in src/boc/Slice.ts:84

loadBoolean

loadBoolean(): boolean
Load a boolean

Returns
true or false depending on the bit value

Returns boolean
- Defined in src/boc/Slice.ts:63

loadBuffer

loadBuffer(bytes: number): Buffer
Load byte buffer

Returns
Buffer
Parameters
- bytes: number
  
  number of bytes to load
Returns Buffer
- Defined in src/boc/Slice.ts:413

loadCoins

loadCoins(): bigint
Load coins

Returns
coins value

Returns bigint
- Defined in src/boc/Slice.ts:298

loadDict

loadDict<K, V>(key: DictionaryKey<K>, value: DictionaryValue<V>): Dictionary<K, V>
Loads dictionary

Returns
Dictionary<K, V>
Type Parameters
- K extends DictionaryKeyTypes
- V
Parameters
- key: DictionaryKey<K>
  
  key description
- value: DictionaryValue<V>
  
  value description
Returns Dictionary<K, V>
- Defined in src/boc/Slice.ts:472

loadDictDirect

loadDictDirect<K, V>(key: DictionaryKey<K>, value: DictionaryValue<V>): Dictionary<K, V>
Loads dictionary directly from current slice

Returns
Dictionary<K, V>
Type Parameters
- K extends DictionaryKeyTypes
- V
Parameters
- key: DictionaryKey<K>
  
  key description
- value: DictionaryValue<V>
  
  value description
Returns Dictionary<K, V>
- Defined in src/boc/Slice.ts:482

loadExternalAddress

loadExternalAddress(): ExternalAddress
Load external address

Returns
ExternalAddress

Returns ExternalAddress
- Defined in src/boc/Slice.ts:342

loadInt

loadInt(bits: number): number
Load int

Returns
int value
Parameters
- bits: number
  
  number of bits to read
Returns number
- Defined in src/boc/Slice.ts:164

loadIntBig

loadIntBig(bits: number): bigint
Load int

Returns
int value
Parameters
- bits: number
  
  number of bits to read
Returns bigint
- Defined in src/boc/Slice.ts:173

loadMaybeAddress

loadMaybeAddress(): null | Address
Load optional internal Address

Returns
Address or null

Returns null | Address
- Defined in src/boc/Slice.ts:334

loadMaybeBoolean

loadMaybeBoolean(): null | boolean
Load maybe boolean

Returns
true or false depending on the bit value or null

Returns null | boolean
- Defined in src/boc/Slice.ts:71

loadMaybeCoins

loadMaybeCoins(): null | bigint
Load maybe coins

Returns
coins value or null

Returns null | bigint
- Defined in src/boc/Slice.ts:314

loadMaybeExternalAddress

loadMaybeExternalAddress(): null | ExternalAddress
Load optional external address

Returns
ExternalAddress or null

Returns null | ExternalAddress
- Defined in src/boc/Slice.ts:350

loadMaybeInt

loadMaybeInt(bits: number): null | number
Load maybe uint

Returns
uint value or null
Parameters
- bits: number
  
  number of bits to read
Returns null | number
- Defined in src/boc/Slice.ts:200

loadMaybeIntBig

loadMaybeIntBig(bits: number): null | bigint
Load maybe uint

Returns
uint value or null
Parameters
- bits: number
  
  number of bits to read
Returns null | bigint
- Defined in src/boc/Slice.ts:213

loadMaybeRef

loadMaybeRef(): null | Cell
Load optional reference

Returns
Cell or null

Returns null | Cell
- Defined in src/boc/Slice.ts:388

loadMaybeStringRefTail

loadMaybeStringRefTail(): null | string
Load maybe string tail from ref

Returns
string or null

Returns null | string
- Defined in src/boc/Slice.ts:457

loadMaybeStringTail

loadMaybeStringTail(): null | string
Load maybe string tail

Returns
string or null

Returns null | string
- Defined in src/boc/Slice.ts:437

loadMaybeUint

loadMaybeUint(bits: number): null | number
Load maybe uint

Returns
uint value or null
Parameters
- bits: number
  
  number of bits to read
Returns null | number
- Defined in src/boc/Slice.ts:138

loadMaybeUintBig

loadMaybeUintBig(bits: number): null | bigint
Load maybe uint

Returns
uint value or null
Parameters
- bits: number
  
  number of bits to read
Returns null | bigint
- Defined in src/boc/Slice.ts:151

loadRef

loadRef(): Cell
Load reference

Returns
Cell

Returns Cell
- Defined in src/boc/Slice.ts:366

loadStringRefTail

loadStringRefTail(): string
Load string tail from ref

Returns
string

Returns string
- Defined in src/boc/Slice.ts:449

loadStringTail

loadStringTail(): string
Load string tail

Returns string
- Defined in src/boc/Slice.ts:429

loadUint

loadUint(bits: number): number
Load uint

Returns
uint value
Parameters
- bits: number
  
  number of bits to read
Returns number
- Defined in src/boc/Slice.ts:102

loadUintBig

loadUintBig(bits: number): bigint
Load uint

Returns
uint value
Parameters
- bits: number
  
  number of bits to read
Returns bigint
- Defined in src/boc/Slice.ts:111

loadVarInt

loadVarInt(bits: number): number
Load varint

Returns
varint value
Parameters
- bits: number
  
  number of bits to read in header
Returns number
- Defined in src/boc/Slice.ts:262

loadVarIntBig

loadVarIntBig(bits: number): bigint
Load varint

Returns
varint value
Parameters
- bits: number
  
  number of bits to read in header
Returns bigint
- Defined in src/boc/Slice.ts:272

loadVarUint

loadVarUint(bits: number): number
Load varuint

Returns
varuint value
Parameters
- bits: number
  
  number of bits to read in header
Returns number
- Defined in src/boc/Slice.ts:226

loadVarUintBig

loadVarUintBig(bits: number): bigint
Load varuint

Returns
varuint value
Parameters
- bits: number
  
  number of bits to read in header
Returns bigint
- Defined in src/boc/Slice.ts:235

preloadBit

preloadBit(): boolean
Preload a signle bit

Returns
true or false depending on the bit value

Returns boolean
- Defined in src/boc/Slice.ts:55

preloadBits

preloadBits(bits: number): BitString
Preload bits as a new BitString

Returns
new BitString
Parameters
- bits: number
  
  number of bits to read
Returns BitString
- Defined in src/boc/Slice.ts:93

preloadBuffer

preloadBuffer(bytes: number): Buffer
Load byte buffer

Returns
Buffer
Parameters
- bytes: number
  
  number of bytes to load
Returns Buffer
- Defined in src/boc/Slice.ts:422

preloadCoins

preloadCoins(): bigint
Preload coins

Returns
coins value

Returns bigint
- Defined in src/boc/Slice.ts:306

preloadInt

preloadInt(bits: number): number
Preload int

Returns
int value
Parameters
- bits: number
  
  number of bits to read
Returns number
- Defined in src/boc/Slice.ts:182

preloadIntBig

preloadIntBig(bits: number): bigint
Preload int

Returns
int value
Parameters
- bits: number
  
  number of bits to read
Returns bigint
- Defined in src/boc/Slice.ts:191

preloadMaybeRef

preloadMaybeRef(): null | Cell
Preload optional reference

Returns
Cell or null

Returns null | Cell
- Defined in src/boc/Slice.ts:400

preloadRef

preloadRef(): Cell
Preload reference

Returns
Cell

Returns Cell
- Defined in src/boc/Slice.ts:377

preloadUint

preloadUint(bits: number): number
Preload uint

Returns
uint value
Parameters
- bits: number
  
  number of bits to read
Returns number
- Defined in src/boc/Slice.ts:120

preloadUintBig

preloadUintBig(bits: number): bigint
Preload uint

Returns
uint value
Parameters
- bits: number
  
  number of bits to read
Returns bigint
- Defined in src/boc/Slice.ts:129

preloadVarInt

preloadVarInt(bits: number): number
Preload varint

Returns
varint value
Parameters
- bits: number
  
  number of bits to read in header
Returns number
- Defined in src/boc/Slice.ts:281

preloadVarIntBig

preloadVarIntBig(bits: number): bigint
Preload varint

Returns
varint value
Parameters
- bits: number
  
  number of bits to read in header
Returns bigint
- Defined in src/boc/Slice.ts:290

preloadVarUint

preloadVarUint(bits: number): number
Preload varuint

Returns
varuint value
Parameters
- bits: number
  
  number of bits to read in header
Returns number
- Defined in src/boc/Slice.ts:244

preloadVarUintBig

preloadVarUintBig(bits: number): bigint
Preload varuint

Returns
varuint value
Parameters
- bits: number
  
  number of bits to read in header
Returns bigint
- Defined in src/boc/Slice.ts:253

skip

skip(bits: number): Slice
Skip bits
Parameters
- bits: number
Returns Slice
- Defined in src/boc/Slice.ts:38

toString

toString(): string
Print slice as string by converting it to cell

Returns
string

Returns string
- Defined in src/boc/Slice.ts:522

Generated using TypeDoc