Record class

A Record is structured using a Map structure.

The Map keys are of the type int and the values are CandidTypes. It is possible to use a String for the field-name when setting a field or looking up a value, however the String field-name gets converted into an int using the candid_text_hash according to the candid-specification. So when iterating through the keys/field-names of the Record the key is an int type. Use the candid_text_hash function to get the int representation of a String field-name. Creating a Record.

var record = Record.of_the_map({
    'greeting': Text('Hi'),
    'name': Text('Bob'),
    'address_info': Record.of_the_map({
        'zip_code': Nat(12345),
        'street_name': Text('Mountain'),
    }),
    'ready': Bool(true)
});

var tuple_style_record = Record.of_the_map({
    0: Nat(5),
    1: Text('green')
});
Inheritance
Implementers

Constructors

Record({dynamic type_mode = false})

Properties

entries Iterable<MapEntry<int, CandidType>>
The map entries of this Map.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
isEmpty bool
Whether there is no key/value pair in the map.
no setterinherited
isNotEmpty bool
Whether there is at least one key/value pair in the map.
no setterinherited
keys Iterable<int>
The keys of this Map.
no setterinherited
length int
The number of key/value pairs in the map.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
type_mode bool
finalinherited
values Iterable<CandidType>
The values of this Map.
no setterinherited

Methods

addAll(Map<int, CandidType> other) → void
Adds all key/value pairs of other to this map.
inherited
addEntries(Iterable<MapEntry<int, CandidType>> newEntries) → void
Adds all key/value pairs of newEntries to this map.
inherited
cast<RK, RV>() Map<RK, RV>
Provides a view of this map as having RK keys and RV instances, if necessary.
inherited
clear() → void
Removes all entries from the map.
inherited
containsKey(dynamic key) bool
Whether this map contains the given key.
inherited
containsValue(Object? value) bool
Whether this map contains the given value.
inherited
find_option<T extends CandidType>(dynamic key) → T?
Candid subtyping rules state that an Option can be missing within a record if it is sent with a null-value. Use this function when looking for an Option in a Record. key can be a String or an int.
forEach(void action(int key, CandidType value)) → void
Applies action to each key/value pair of the map.
inherited
map<K2, V2>(MapEntry<K2, V2> transform(int key, CandidType value)) Map<K2, V2>
Returns a new map where all entries of this map are transformed by the given convert function.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putIfAbsent(int key, CandidType ifAbsent()) CandidType
Look up the value of key, or add a new entry if it isn't there.
inherited
remove(Object? key) CandidType?
Removes key and its associated value, if present, from the map.
inherited
removeWhere(bool test(int key, CandidType value)) → void
Removes all entries of this map that satisfy the given test.
inherited
toString() String
A string representation of this object.
inherited
update(int key, CandidType update(CandidType value), {CandidType ifAbsent()?}) CandidType
Updates the value for the provided key.
inherited
updateAll(CandidType update(int key, CandidType value)) → void
Updates all values.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited
operator [](dynamic key) CandidType?
The value for the given key, or null if key is not in the map.
inherited
operator []=(dynamic key, CandidType value) → void
Associates the key with the given value.
inherited

Static Methods

of_the_map(Map<dynamic, CandidType> record_map, {dynamic type_mode = false}) → dynamic

Constants

type_code → const int