Class CLTypeResult

Represents a Result type in the Casper type system. This class implements the CLType interface, allowing for Result types with defined Ok and Err types.

Hierarchy

CLTypeResult

Implements

CLType

Index

Constructors

constructor

new CLTypeResult(innerOk: CLType, innerErr: CLType): CLTypeResult
Initializes a new instance of the CLTypeResult class.
Parameters
- innerOk: CLType
  
  The CLType of the Ok value.
- innerErr: CLType
  
  The CLType of the Err value.
Returns CLTypeResult
- Defined in src/types/clvalue/cltype/Result.ts:32

Properties

innerErr

innerErr: CLType

The CLType of the Err value in the Result.

innerOk

innerOk: CLType

The CLType of the Ok value in the Result.

Methods

getName

getName(): string
Retrieves the name of the CLTypeResult.

Returns
The TypeName for Result.

Returns string
Implementation of CLType.getName
- Defined in src/types/clvalue/cltype/Result.ts:70

getTypeID

getTypeID(): TypeID
Retrieves the type ID of the CLTypeResult.

Returns
The TypeID associated with Result.

Returns TypeID
Implementation of CLType.getTypeID
- Defined in src/types/clvalue/cltype/Result.ts:62

toBytes

toBytes(): Uint8Array
Converts the CLTypeResult instance to its byte representation. This includes the type ID for Result, followed by the byte representations of the Ok and Err types.

Returns
A Uint8Array representing the CLTypeResult.

Returns Uint8Array
Implementation of CLType.toBytes
- Defined in src/types/clvalue/cltype/Result.ts:42

toJSON

toJSON(): {
    [key: string]: {
        err: CLType;
        ok: CLType;
    };
}
Converts the CLTypeResult instance to a JSON-compatible representation. The JSON object includes a "Result" key containing the JSON representations of the Ok and Err types.

Returns
A JSON object representing the Result type and its Ok and Err types.

Returns {
    [key: string]: {
        err: CLType;
        ok: CLType;
    };
}
- [key: string]: {
  err: CLType;
  ok: CLType;
  }
  - err: CLType
  - ok: CLType
Implementation of CLType.toJSON
- Defined in src/types/clvalue/cltype/Result.ts:79

toString

toString(): string
Provides a string representation of the CLTypeResult.

Returns
A string in the format "(Result: Ok(okType), Err(errType))".

Returns string
Implementation of CLType.toString
- Defined in src/types/clvalue/cltype/Result.ts:54

`Static` fromJSON

fromJSON(source: any): CLTypeResult
Creates a CLTypeResult instance from a JSON representation. Parses JSON input to determine the Ok and Err types for the Result.

Returns
A new CLTypeResult instance with parsed Ok and Err types.

Throws
If the JSON structure is invalid.
Parameters
- source: any
  
  The JSON representation of the CLTypeResult.
Returns CLTypeResult
- Defined in src/types/clvalue/cltype/Result.ts:95

Class CLTypeResult

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

innerOk: CLType

innerErr: CLType

Returns CLTypeResult

Properties

innerErr

innerOk

Methods

getName

Returns

Returns string

getTypeID

Returns

Returns TypeID

toBytes

Returns

Returns Uint8Array

toJSON

Returns

Returns { [key: string]: { err: CLType; ok: CLType; }; }

[key: string]: { err: CLType; ok: CLType; }

err: CLType

ok: CLType

toString

Returns

Returns string

Static fromJSON

Returns

Throws

Parameters

source: any

Returns CLTypeResult

Settings

Member Visibility

Theme

Returns {
[key: string]: {
err: CLType;
ok: CLType;
};
}

[key: string]: {
err: CLType;
ok: CLType;
}

`Static` fromJSON