FieldOptions class

Available extensions

Constructors

FieldOptions({FieldOptions_CType? ctype, bool? packed, bool? deprecated, bool? lazy, FieldOptions_JSType? jstype, bool? weak, bool? unverifiedLazy, bool? debugRedact, FieldOptions_OptionRetention? retention, Iterable<FieldOptions_OptionTargetType>? targets, Iterable<FieldOptions_EditionDefault>? editionDefaults, FeatureSet? features, FieldOptions_FeatureSupport? featureSupport, Iterable<UninterpretedOption>? uninterpretedOption})
factory
FieldOptions.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
FieldOptions.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

ctype ↔ FieldOptions_CType
NOTE: ctype is deprecated. Use features.(pb.cpp).string_type instead. The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is only implemented to support use of ctype=CORD and ctype=STRING (the default) on non-repeated fields of type "bytes" in the open source release. TODO: make ctype actually deprecated.
getter/setter pair
debugRedact ↔ bool
Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.
getter/setter pair
deprecated ↔ bool
Is this field deprecated? Depending on the target platform, this can emit Deprecated annotations for accessors, or it will be completely ignored; in the very least, this is a formalization for deprecating fields.
getter/setter pair
editionDefaults → PbList<FieldOptions_EditionDefault>
no setter
features ↔ FeatureSet
Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.
getter/setter pair
featureSupport ↔ FieldOptions_FeatureSupport
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setter
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
jstype ↔ FieldOptions_JSType
The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript "number" type. The behavior of the default option JS_NORMAL is implementation dependent.
getter/setter pair
lazy ↔ bool
Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message's contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed.
getter/setter pair
packed ↔ bool
The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire. Rather than repeatedly writing the tag and type for each element, the entire array is encoded as a single length-delimited blob. In proto3, only explicit setting it to false will avoid using packed encoding. This option is prohibited in Editions, but the repeated_field_encoding feature can be used to control the behavior.
getter/setter pair
retention ↔ FieldOptions_OptionRetention
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
targets → PbList<FieldOptions_OptionTargetType>
no setter
uninterpretedOption → PbList<UninterpretedOption>
The parser stores options it doesn't recognize here. See above.
no setter
unknownFields → UnknownFieldSet
no setterinherited
unverifiedLazy ↔ bool
unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.
getter/setter pair
weak ↔ bool
For Google-internal migration only. Do not use.
getter/setter pair

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
clearCtype() → void
clearDebugRedact() → void
clearDeprecated() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearFeatures() → void
clearFeatureSupport() → void
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearJstype() → void
clearLazy() → void
clearPacked() → void
clearRetention() → void
clearUnverifiedLazy() → void
clearWeak() → void
clone() → FieldOptions
Creates a deep copy of the fields in this message.
copyWith(void updates(FieldOptions)) → FieldOptions
Apply updates to a copy of this message.
createEmptyInstance() → FieldOptions
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.
ensureFeatures() → FeatureSet
ensureFeatureSupport() → FieldOptions_FeatureSupport
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
hasCtype() → bool
hasDebugRedact() → bool
hasDeprecated() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasFeatures() → bool
hasFeatureSupport() → bool
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasJstype() → bool
hasLazy() → bool
hasPacked() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasRetention() → bool
hasUnverifiedLazy() → bool
hasWeak() → bool
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 a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.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 other into 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

Apply updates to 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 given CodedBufferWriter.
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() → FieldOptions
getDefault() → FieldOptions