Class Result<O, E>

Name

Result

Description

A Result maps to the Rust Result type, that can either wrap a success or error value

Type Parameters

O extends Codec
E extends Codec

Hierarchy (View Summary)

Enum
- Result

Implements

IResult<O, E>

Index

Constructors

constructor

new Result<O extends Codec, E extends Codec>(
    registry: Registry,
    Ok: string | CodecClass<O, any[]>,
    Err: string | CodecClass<E, any[]>,
    value?: unknown,
): Result<O, E>
Type Parameters
- O extends Codec
- E extends Codec
Parameters
- registry: Registry
- Ok: string | CodecClass<O, any[]>
- Err: string | CodecClass<E, any[]>
- Optionalvalue: unknown
Returns Result<O, E>
Overrides Enum.constructor
- Defined in packages/types-codec/src/base/Result.ts:14

Properties

`Optional`createdAtHash

createdAtHash?: IU8a

Description

The block at which this value was retrieved/created (set to non-empty when retrieved from storage)

`Optional`initialU8aLength

initialU8aLength?: number

Description

The length of the initial encoded value (Only available when the value was constructed from a Uint8Array input)

`Optional`isStorageFallback

isStorageFallback?: boolean

Description

(internal usage) Indicates that the value was created via a fallback. This is used when with data specified in the metadata when the storage entry is empty.

With metadata fallback values (available as defaults on most storage entries) any empty storage item should erturn the default. (This is the same as the implementation on the Bizinikiwi runtime)

`Readonly`registry

registry: Registry

Description

The registry associated with this object

Accessors

asErr

get asErr(): E
Returns E

Description
Returns the wrapper Err value (if isErr)
Implementation of IResult.asErr
- Defined in packages/types-codec/src/base/Result.ts:31

asOk

get asOk(): O
Returns O

Description
Returns the wrapper Ok value (if isOk)
Implementation of IResult.asOk
- Defined in packages/types-codec/src/base/Result.ts:42

defIndexes

get defIndexes(): number[]
Returns number[]

Description
The available keys for this enum
Implementation of IResult.defIndexes

Inherited from Enum.defIndexes
- Defined in packages/types-codec/src/base/Enum.ts:303

defKeys

get defKeys(): string[]
Returns string[]

Description
The available keys for this enum
Implementation of IResult.defKeys

Inherited from Enum.defKeys
- Defined in packages/types-codec/src/base/Enum.ts:310

encodedLength

get encodedLength(): number
Returns number

Description
The length of the value when encoded as a Uint8Array
Implementation of IResult.encodedLength

Inherited from Enum.encodedLength
- Defined in packages/types-codec/src/base/Enum.ts:254

hash

get hash(): IU8a
Returns IU8a

Description
returns a hash of the contents
Implementation of IResult.hash

Inherited from Enum.hash
- Defined in packages/types-codec/src/base/Enum.ts:261

index

get index(): number
Returns number

Description
The index of the enum value
Implementation of IResult.index

Inherited from Enum.index
- Defined in packages/types-codec/src/base/Enum.ts:268

inner

get inner(): Codec
Returns Codec

Description
The value of the enum
Inherited from Enum.inner
- Defined in packages/types-codec/src/base/Enum.ts:275

isBasic

get isBasic(): boolean
Returns boolean

Description
true if this is a basic enum (no values)
Implementation of IResult.isBasic

Inherited from Enum.isBasic
- Defined in packages/types-codec/src/base/Enum.ts:282

isEmpty

get isEmpty(): boolean
Returns boolean

Description
Checks if the Result has no value
Implementation of IResult.isEmpty

Overrides Enum.isEmpty
- Defined in packages/types-codec/src/base/Result.ts:53

isErr

get isErr(): boolean
Returns boolean

Description
Checks if the Result wraps an Err value
Implementation of IResult.isErr
- Defined in packages/types-codec/src/base/Result.ts:60

isNone

get isNone(): boolean
Returns boolean

Description
Checks if the Enum points to a [[Null]] type
Inherited from Enum.isNone
- Defined in packages/types-codec/src/base/Enum.ts:296

isOk

get isOk(): boolean
Returns boolean

Description
Checks if the Result wraps an Ok value
Implementation of IResult.isOk
- Defined in packages/types-codec/src/base/Result.ts:67

type

get type(): string
Returns string

Description
The name of the type this enum value represents
Implementation of IResult.type

Inherited from Enum.type
- Defined in packages/types-codec/src/base/Enum.ts:317

value

get value(): Codec
Returns Codec

Description
The value of the enum
Implementation of IResult.value

Inherited from Enum.value
- Defined in packages/types-codec/src/base/Enum.ts:324

Methods

`Protected`_toRawStruct

_toRawStruct(): string[] | Record<string, string | number>
Returns string[] | Record<string, string | number>

Description
Returns a raw struct representation of the enum types
Inherited from Enum._toRawStruct
- Defined in packages/types-codec/src/base/Enum.ts:411

eq

eq(other?: unknown): boolean
Parameters
- Optionalother: unknown
Returns boolean

Description
Compares the value of the input to see if there is a match
Implementation of IResult.eq

Inherited from Enum.eq
- Defined in packages/types-codec/src/base/Enum.ts:331

inspect

inspect(): Inspect
Returns Inspect

Description
Returns a breakdown of the hex encoding for this Codec
Implementation of IResult.inspect

Inherited from Enum.inspect
- Defined in packages/types-codec/src/base/Enum.ts:354

toHex

toHex(): `0x${string}`
Returns `0x${string}`

Description
Returns a hex string representation of the value
Implementation of IResult.toHex

Inherited from Enum.toHex
- Defined in packages/types-codec/src/base/Enum.ts:370

toHuman

toHuman(isExtended?: boolean, disableAscii?: boolean): AnyJson
Parameters
- OptionalisExtended: boolean
- OptionaldisableAscii: boolean
Returns AnyJson

Description
Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
Implementation of IResult.toHuman

Inherited from Enum.toHuman
- Defined in packages/types-codec/src/base/Enum.ts:377

toJSON

toJSON(): AnyJson
Returns AnyJson

Description
Converts the Object to JSON, typically used for RPC transfers
Implementation of IResult.toJSON

Inherited from Enum.toJSON
- Defined in packages/types-codec/src/base/Enum.ts:386

toNumber

toNumber(): number
Returns number

Description
Returns the number representation for the value
Implementation of IResult.toNumber

Inherited from Enum.toNumber
- Defined in packages/types-codec/src/base/Enum.ts:395

toPrimitive

toPrimitive(disableAscii?: boolean): AnyJson
Parameters
- OptionaldisableAscii: boolean
Returns AnyJson

Description
Converts the value in a best-fit primitive form
Implementation of IResult.toPrimitive

Inherited from Enum.toPrimitive
- Defined in packages/types-codec/src/base/Enum.ts:402

toRawType

toRawType(): string
Returns string

Description
Returns the base runtime type name for this instance
Implementation of IResult.toRawType

Overrides Enum.toRawType
- Defined in packages/types-codec/src/base/Result.ts:74

toString

toString(): string
Returns string

Description
Returns the string representation of the value
Implementation of IResult.toString

Inherited from Enum.toString
- Defined in packages/types-codec/src/base/Enum.ts:442

toU8a

toU8a(isBare?: boolean): Uint8Array
Parameters
- OptionalisBare: boolean
  true when the value has none of the type-specific prefixes (internal)
Returns Uint8Array

Description
Encodes the value as a Uint8Array as per the SCALE specifications
Implementation of IResult.toU8a

Inherited from Enum.toU8a
- Defined in packages/types-codec/src/base/Enum.ts:452

`Static`with

with<O extends Codec, E extends Codec>(
    Types: {
        Err: string | CodecClass<E, any[]>;
        Ok: string | CodecClass<O, any[]>;
    },
): CodecClass<Result<O, E>>
Type Parameters
- O extends Codec
- E extends Codec
Parameters
- Types: { Err: string | CodecClass<E, any[]>; Ok: string | CodecClass<O, any[]> }
Returns CodecClass<Result<O, E>>
Overrides Enum.with
- Defined in packages/types-codec/src/base/Result.ts:20

Class Result<O, E>

Name

Description

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Result<O, E>

Properties

OptionalcreatedAtHash

Description

OptionalinitialU8aLength

Description

OptionalisStorageFallback

Description

Readonlyregistry

Description

Accessors

asErr

Returns E

Description

asOk

Returns O

Description

defIndexes

Returns number[]

Description

defKeys

Returns string[]

Description

encodedLength

Returns number

Description

hash

Returns IU8a

Description

index

Returns number

Description

inner

Returns Codec

Description

isBasic

Returns boolean

Description

isEmpty

Returns boolean

Description

isErr

Returns boolean

Description

isNone

Returns boolean

Description

isOk

Returns boolean

Description

type

Returns string

Description

value

Returns Codec

Description

Methods

Protected_toRawStruct

Returns string[] | Record<string, string | number>

Description

eq

Parameters

Returns boolean

Description

inspect

`Optional`createdAtHash

`Optional`initialU8aLength

`Optional`isStorageFallback

`Readonly`registry

`Protected`_toRawStruct

`Static`with