Instance Propertyswift-protobuf 1.28.1SwiftProtobuf

lazy

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.

descriptor.pb.swift:1630

var lazy: Bool { get set }

Mangled symbol

s13SwiftProtobuf07Google_B13_FieldOptionsV4lazySbvpWhat are these?

FNV24: [6KR58]

This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it.

This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access.

Note that lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable).

Other members in extension

Types

enum CType
struct EditionDefault
struct FeatureSupport
Information about the support window of a feature.
enum JSType
enum OptionRetention
If set to RETENTION_SOURCE, the option will be omitted from the binary. Note: as of January 2023, support for this is in progress and does not yet have an effect (b/264593489).
enum OptionTargetType
This indicates the types of entities that the field may apply to when used as an option. If it is unset, then the field may be freely used as an option on any kind of entity. Note: as of January 2023, support for this is in progress and does not yet have an effect (b/264593489).

Type members

Show implementation details (1)

static let _protobuf_nameMap: _NameMap

Instance members

var ctype: Google_Protobuf_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.
var debugRedact: Bool
Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.
var 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.
var editionDefaults: [Google_Protobuf_FieldOptions.EditionDefault]
var featureSupport: Google_Protobuf_FieldOptions.FeatureSupport
var features: Google_Protobuf_FeatureSet
Any features defined in the specific edition.
var hasCtype: Bool
Returns true if ctype has been explicitly set.
var hasDebugRedact: Bool
Returns true if debugRedact has been explicitly set.
var hasDeprecated: Bool
Returns true if deprecated has been explicitly set.
var hasFeatureSupport: Bool
Returns true if featureSupport has been explicitly set.
var hasFeatures: Bool
Returns true if features has been explicitly set.
var hasJstype: Bool
Returns true if jstype has been explicitly set.
var hasLazy: Bool
Returns true if lazy has been explicitly set.
var hasPacked: Bool
Returns true if packed has been explicitly set.
var hasRetention: Bool
Returns true if retention has been explicitly set.
var hasUnverifiedLazy: Bool
Returns true if unverifiedLazy has been explicitly set.
var hasWeak: Bool
Returns true if weak has been explicitly set.
var isInitialized: Bool
var jstype: Google_Protobuf_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.
var 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.
var retention: Google_Protobuf_FieldOptions.OptionRetention
var targets: [Google_Protobuf_FieldOptions.OptionTargetType]
var uninterpretedOption: [Google_Protobuf_UninterpretedOption]
The parser stores options it doesn’t recognize here. See above.
var unknownFields: UnknownStorage
var 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.
var weak: Bool
For Google-internal migration only. Do not use.
func clearCtype()
Clears the value of ctype. Subsequent reads from it will return its default value.
func clearDebugRedact()
Clears the value of debugRedact. Subsequent reads from it will return its default value.
func clearDeprecated()
Clears the value of deprecated. Subsequent reads from it will return its default value.
func clearFeatureSupport()
Clears the value of featureSupport. Subsequent reads from it will return its default value.
func clearFeatures()
Clears the value of features. Subsequent reads from it will return its default value.
func clearJstype()
Clears the value of jstype. Subsequent reads from it will return its default value.
func clearLazy()
Clears the value of lazy. Subsequent reads from it will return its default value.
func clearPacked()
Clears the value of packed. Subsequent reads from it will return its default value.
func clearRetention()
Clears the value of retention. Subsequent reads from it will return its default value.
func clearUnverifiedLazy()
Clears the value of unverifiedLazy. Subsequent reads from it will return its default value.
func clearWeak()
Clears the value of weak. Subsequent reads from it will return its default value.
func decodeMessage<D>(decoder: inout D) throws
func traverse<V>(visitor: inout V) throws

Show implementation details (1)

var _protobuf_extensionFieldValues: ExtensionFieldValueSet