Class CborSet<C, T>

CborSet encapsulates a Mathematical finite set.

In the Cardano CDDL, sets have been represented as simple arrays, so the implementation supports both the array, and the 258 tag representation.

Type Parameters

C
T extends CborSerializable<C>

Hierarchy

CborSet

Index

Constructors

`Private` constructor

new CborSet<C, T>(values: T[]): Serialization.CborSet<C, T>
Type Parameters
- C
- T extends CborSerializable<C, T>
Parameters
- values: T[]
Returns Serialization.CborSet<C, T>
- Defined in packages/core/src/Serialization/Common/CborSet.ts:22

Properties

`Private` #values

#values: T[]

`Static` useConwaySerialization

useConwaySerialization: boolean = false

Methods

setValues

setValues(values: T[]): void
Returns the values of the set as an array
Parameters
- values: T[]
Returns void
- Defined in packages/core/src/Serialization/Common/CborSet.ts:94

size

size(): number
Returns number
- Defined in packages/core/src/Serialization/Common/CborSet.ts:98

toCbor

toCbor(): HexBlob
Serializes a CborSet into CBOR format.

Returns
The CborSet in CBOR format, using the 258 tag representation if useConwaySerialization flag is set, or as an the array.

Returns HexBlob
- Defined in packages/core/src/Serialization/Common/CborSet.ts:56

toCore

toCore(): C[]
Returns
the set as an array of Core objects

Returns C[]
- Defined in packages/core/src/Serialization/Common/CborSet.ts:73

values

values(): readonly T[]
Returns the values of the set as an array

Returns readonly T[]
- Defined in packages/core/src/Serialization/Common/CborSet.ts:89

`Static` fromCbor

fromCbor<C, S>(cbor: HexBlob, fromCbor: ((cbor: HexBlob) => S)): Serialization.CborSet<C, S>
Deserializes a set from a CBOR byte array represented as either an array or a 258 tag

Returns
a new CborSet~~, where S is the type of items in the set.~~

Type Parameters

C

S extends CborSerializable<C, S>

Parameters

cbor: HexBlob

The CBOR encoded set.

fromCbor: ((cbor: HexBlob) => S)

The function to use when deserializing each set element.

(cbor: HexBlob): S

Parameters

cbor: HexBlob

Returns S

Returns Serialization.CborSet<C, S>

Defined in packages/core/src/Serialization/Common/CborSet.ts:33

Static fromCore

fromCore<C, S>(coreValues: C[], fromCore: ((coreValue: C) => S)): Serialization.CborSet<C, S>

Creates a CborSet object from the given array of Core objects.

Returns
a CborSet

Type Parameters

C

S extends CborSerializable<C, S>

Parameters

coreValues: C[]

An array of Core type objects

fromCore: ((coreValue: C) => S)

method that coverts the core object into a CborSerializable object

(coreValue: C): S

Parameters

coreValue: C

Returns S

Returns Serialization.CborSet<C, S>

Defined in packages/core/src/Serialization/Common/CborSet.ts:84

Class CborSet<C, T>

Type Parameters

C

T extends CborSerializable<C>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Type Parameters

C

T extends CborSerializable<C, T>

Parameters

values: T[]

Returns Serialization.CborSet<C, T>

Properties

Private #values

Static useConwaySerialization

Methods

setValues

Parameters

values: T[]

Returns void

size

Returns number

toCbor

Returns

Returns HexBlob

toCore

Returns

Returns C[]

values

Returns readonly T[]

Static fromCbor

Returns

Type Parameters

C

S extends CborSerializable<C, S>

Parameters

cbor: HexBlob

fromCbor: ((cbor: HexBlob) => S)

Parameters

cbor: HexBlob

Returns S

Returns Serialization.CborSet<C, S>

Static fromCore

Returns

Type Parameters

C

S extends CborSerializable<C, S>

Parameters

coreValues: C[]

fromCore: ((coreValue: C) => S)

Parameters

coreValue: C

Returns S

Returns Serialization.CborSet<C, S>

Settings

Member Visibility

Theme

`Private` constructor

`Private` #values

`Static` useConwaySerialization

`Static` fromCbor

`Static` fromCore