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 node_modules/ton-core/dist/boc/Slice.d.ts:12

Properties

[SymbolInspect]

[SymbolInspect]: (() => string)

Type declaration

- (): string
- Returns string

`Private` _reader

_reader: any

`Private` _refs

_refs: any

Accessors

remainingBits

get remainingBits(): number
Get remaining bits

Returns number
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:16

remainingRefs

get remainingRefs(): number
Get remaining refs

Returns number
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:20

Methods

asBuilder

asBuilder(): Builder
Returns

Returns Builder
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:261

asCell

asCell(): Cell
Convert slice to cell

Returns Cell
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:256

clone

clone(): Slice
Clone slice

Returns
cloned slice

Returns Slice
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:266

endParse

endParse(): void
Checks if slice is empty

Returns void
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:252

loadAddress

loadAddress(): Address
Load internal Address

Returns
Address

Returns Address
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:163

loadAddressAny

loadAddressAny(): null | Address | ExternalAddress
Load address

Returns
Address, ExternalAddress or null

Returns null | Address | ExternalAddress
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:183

loadBit

loadBit(): boolean
Load a single bit

Returns
true or false depending on the bit value

Returns boolean
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:30

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 node_modules/ton-core/dist/boc/Slice.d.ts:41

loadBuffer

loadBuffer(bytes: number): Buffer
Load byte buffer

Returns
Buffer
Parameters
- bytes: number
  
  number of bytes to load
Returns Buffer
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:209

loadCoins

loadCoins(): bigint
Load coins

Returns
coins value

Returns bigint
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:148

loadDict

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

Returns
Dictionary<K, V>
Type Parameters
- K
- V
Parameters
- key: DictionaryKey<K>
  
  key description
- value: DictionaryValue<V>
  
  value description
Returns Dictionary<K, V>
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:241

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
- V
Parameters
- key: DictionaryKey<K>
  
  key description
- value: DictionaryValue<V>
  
  value description
Returns Dictionary<K, V>
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:248

loadExternalAddress

loadExternalAddress(): ExternalAddress
Load external address

Returns
ExternalAddress

Returns ExternalAddress
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:173

loadInt

loadInt(bits: number): number
Load int

Returns
int value
Parameters
- bits: number
  
  number of bits to read
Returns number
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:77

loadIntBig

loadIntBig(bits: number): bigint
Load int

Returns
int value
Parameters
- bits: number
  
  number of bits to read
Returns bigint
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:83

loadMaybeAddress

loadMaybeAddress(): null | Address
Load optional internal Address

Returns
Address or null

Returns null | Address
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:168

loadMaybeCoins

loadMaybeCoins(): null | bigint
Load maybe coins

Returns
coins value or null

Returns null | bigint
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:158

loadMaybeExternalAddress

loadMaybeExternalAddress(): null | ExternalAddress
Load optional external address

Returns
ExternalAddress or null

Returns null | ExternalAddress
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:178

loadMaybeRef

loadMaybeRef(): null | Cell
Load optional reference

Returns
Cell or null

Returns null | Cell
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:198

loadMaybeStringRefTail

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

Returns
string or null

Returns null | string
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:234

loadMaybeStringTail

loadMaybeStringTail(): null | string
Load maybe string tail

Returns
string or null

Returns null | string
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:224

loadRef

loadRef(): Cell
Load reference

Returns
Cell

Returns Cell
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:188

loadStringRefTail

loadStringRefTail(): string
Load string tail from ref

Returns
string

Returns string
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:229

loadStringTail

loadStringTail(): string
Load string tail

Returns string
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:219

loadUint

loadUint(bits: number): number
Load uint

Returns
uint value
Parameters
- bits: number
  
  number of bits to read
Returns number
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:53

loadUintBig

loadUintBig(bits: number): bigint
Load uint

Returns
uint value
Parameters
- bits: number
  
  number of bits to read
Returns bigint
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:59

loadVarInt

loadVarInt(bits: number): number
Load varint

Returns
varint value
Parameters
- bits: number
  
  number of bits to read in header
Returns number
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:125

loadVarIntBig

loadVarIntBig(bits: number): bigint
Load varint

Returns
varint value
Parameters
- bits: number
  
  number of bits to read in header
Returns bigint
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:131

loadVarUint

loadVarUint(bits: number): number
Load varuint

Returns
varuint value
Parameters
- bits: number
  
  number of bits to read in header
Returns number
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:101

loadVarUintBig

loadVarUintBig(bits: number): bigint
Load varuint

Returns
varuint value
Parameters
- bits: number
  
  number of bits to read in header
Returns bigint
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:107

preloadBit

preloadBit(): boolean
Preload a signle bit

Returns
true or false depending on the bit value

Returns boolean
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:35

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 node_modules/ton-core/dist/boc/Slice.d.ts:47

preloadBuffer

preloadBuffer(bytes: number): Buffer
Load byte buffer

Returns
Buffer
Parameters
- bytes: number
  
  number of bytes to load
Returns Buffer
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:215

preloadCoins

preloadCoins(): bigint
Preload coins

Returns
coins value

Returns bigint
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:153

preloadInt

preloadInt(bits: number): number
Preload int

Returns
int value
Parameters
- bits: number
  
  number of bits to read
Returns number
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:89

preloadIntBig

preloadIntBig(bits: number): bigint
Preload int

Returns
int value
Parameters
- bits: number
  
  number of bits to read
Returns bigint
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:95

preloadMaybeRef

preloadMaybeRef(): null | Cell
Preload optional reference

Returns
Cell or null

Returns null | Cell
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:203

preloadRef

preloadRef(): Cell
Preload reference

Returns
Cell

Returns Cell
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:193

preloadUint

preloadUint(bits: number): number
Preload uint

Returns
uint value
Parameters
- bits: number
  
  number of bits to read
Returns number
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:65

preloadUintBig

preloadUintBig(bits: number): bigint
Preload uint

Returns
uint value
Parameters
- bits: number
  
  number of bits to read
Returns bigint
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:71

preloadVarInt

preloadVarInt(bits: number): number
Preload varint

Returns
varint value
Parameters
- bits: number
  
  number of bits to read in header
Returns number
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:137

preloadVarIntBig

preloadVarIntBig(bits: number): bigint
Preload varint

Returns
varint value
Parameters
- bits: number
  
  number of bits to read in header
Returns bigint
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:143

preloadVarUint

preloadVarUint(bits: number): number
Preload varuint

Returns
varuint value
Parameters
- bits: number
  
  number of bits to read in header
Returns number
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:113

preloadVarUintBig

preloadVarUintBig(bits: number): bigint
Preload varuint

Returns
varuint value
Parameters
- bits: number
  
  number of bits to read in header
Returns bigint
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:119

skip

skip(bits: number): Slice
Skip bits
Parameters
- bits: number
Returns Slice
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:25

toString

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

Returns
string

Returns string
- Defined in node_modules/ton-core/dist/boc/Slice.d.ts:271

Generated using TypeDoc