Module class
A module groups related type definitions and functions. Modules can import other modules to use their types and functions. Base modules (like "std") provide platform-specific implementations.
- Available extensions
Constructors
-
Module({String? name, Iterable<
FunctionDefinition> ? functions, Iterable<ModuleImport> ? moduleImports, String? description, Struct? metadata, Iterable<EnumDescriptorProto> ? enums, Iterable<TypeDefinition> ? typeDefs, Iterable<TypeAlias> ? typeAliases, Iterable<Constant> ? moduleConstants, Iterable<ModuleAsset> ? assets}) -
factory
-
Module.fromBuffer(List<
int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) -
factory
- Module.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
-
assets
→ PbList<
ModuleAsset> -
Asset files embedded in this module (images, JSON fixtures, etc.).
Any file can be stored as an asset; the path is relative to the
package root.
no setter
- description ↔ String
-
Human-readable description
getter/setter pair
-
enums
→ PbList<
EnumDescriptorProto> -
Enum types defined using protobuf's own enum descriptor format.
no setter
-
functions
→ PbList<
FunctionDefinition> -
Function definitions in this module
no setter
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setter
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - metadata ↔ Struct
-
Arbitrary metadata — supports infinite nesting.
getter/setter pair
-
moduleConstants
→ PbList<
Constant> -
Module-level constants (e.g.,
const pi = 3.14159).no setter -
moduleImports
→ PbList<
ModuleImport> -
Structured module imports with source resolution and integrity verification.
no setter
- name ↔ String
-
Unique module name (e.g., "std", "main", "my_lib")
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
typeAliases
→ PbList<
TypeAlias> -
Type aliases (e.g., C++
using, Rusttype, TypeScripttype).no setter -
typeDefs
→ PbList<
TypeDefinition> -
First-class type definitions (replaces the meta function hack).
Each TypeDefinition has a name, protobuf descriptor for fields,
generic type parameters, and a metadata bag for cosmetic hints
(kind, superclass, interfaces, mixins, visibility, etc.).
no setter
- unknownFields → UnknownFieldSet
-
no setterinherited
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
Throws a StateError if the message has required fields without a value.
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearDescription(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearMetadata(
) → void -
clearName(
) → void -
clone(
) → Module - Creates a deep copy of the fields in this message.
-
copyWith(
void updates(Module)) → Module -
Apply
updatesto a copy of this message. -
createEmptyInstance(
) → Module - Creates an empty instance of the same message type as this.
-
deepCopy(
) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Returns a writable deep copy of this message. -
ensureMetadata(
) → Struct -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasDescription(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasMetadata(
) → bool -
hasName(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Same as
mergeFromBuffer, but takes aCodedBufferReaderinput.inherited -
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rebuild(
void updates(T)) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Applyupdatesto a copy of this message. -
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
writeToBuffer(
) → Uint8List -
Serialize the message as the protobuf binary format.
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
Same as
writeToBuffer, but serializes to the givenCodedBufferWriter.inherited -
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → Module -
getDefault(
) → Module