JSType

import SwiftProtobuf

Support library for Swift code generated by protoc-gen-swift.

struct Google_Protobuf_FieldOptions

case jsNormal

Use the default type.

case jsString

Use JavaScript strings.

case jsNumber

Use JavaScript numbers.

init()

static let _protobuf_nameMap: _NameMap

static let protoMessageName: String

var _protobuf_extensionFieldValues: ExtensionFieldValueSet

var ctype: Google_Protobuf_FieldOptions.CType { get set }

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 { get set }

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 { get set }

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] { get set }

var featureSupport: Google_Protobuf_FieldOptions.FeatureSupport { get set }

var features: Google_Protobuf_FeatureSet { get set }

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.

var hasCtype: Bool { get }

Returns true if ctype has been explicitly set.

var hasDebugRedact: Bool { get }

Returns true if debugRedact has been explicitly set.

var hasDeprecated: Bool { get }

Returns true if deprecated has been explicitly set.

var hasFeatureSupport: Bool { get }

Returns true if featureSupport has been explicitly set.

var hasFeatures: Bool { get }

Returns true if features has been explicitly set.

var hasJstype: Bool { get }

Returns true if jstype has been explicitly set.

var hasLazy: Bool { get }

Returns true if lazy has been explicitly set.

var hasPacked: Bool { get }

Returns true if packed has been explicitly set.

var hasRetention: Bool { get }

Returns true if retention has been explicitly set.

var hasUnverifiedLazy: Bool { get }

Returns true if unverifiedLazy has been explicitly set.

var hasWeak: Bool { get }

Returns true if weak has been explicitly set.

var isInitialized: Bool { get }

var jstype: Google_Protobuf_FieldOptions.JSType { get set }

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 lazy: Bool { get set }

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.

var packed: Bool { get set }

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 { get set }

var targets: [Google_Protobuf_FieldOptions.OptionTargetType] { get set }

var uninterpretedOption: [Google_Protobuf_UninterpretedOption] { get set }

The parser stores options it doesn’t recognize here. See above.

var unknownFields: UnknownStorage

var unverifiedLazy: Bool { get set }

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 { get set }

For Google-internal migration only. Do not use.

static func == (lhs: Google_Protobuf_FieldOptions, rhs: Google_Protobuf_FieldOptions) -> Bool

mutating func clearCtype()

Clears the value of ctype. Subsequent reads from it will return its default value.

mutating func clearDebugRedact()

Clears the value of debugRedact. Subsequent reads from it will return its default value.

mutating func clearDeprecated()

Clears the value of deprecated. Subsequent reads from it will return its default value.

mutating func clearFeatureSupport()

Clears the value of featureSupport. Subsequent reads from it will return its default value.

mutating func clearFeatures()

Clears the value of features. Subsequent reads from it will return its default value.

mutating func clearJstype()

Clears the value of jstype. Subsequent reads from it will return its default value.

mutating func clearLazy()

Clears the value of lazy. Subsequent reads from it will return its default value.

mutating func clearPacked()

Clears the value of packed. Subsequent reads from it will return its default value.

mutating func clearRetention()

Clears the value of retention. Subsequent reads from it will return its default value.

mutating func clearUnverifiedLazy()

Clears the value of unverifiedLazy. Subsequent reads from it will return its default value.

mutating func clearWeak()

Clears the value of weak. Subsequent reads from it will return its default value.

mutating func decodeMessage<D>(decoder: inout D) throws where D : Decoder

func traverse<V>(visitor: inout V) throws where V : Visitor

enum CType

struct EditionDefault

struct FeatureSupport

Information about the support window of a feature.

enum OptionRetention

If set to RETENTION_SOURCE, the option will be omitted from the binary.

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.

protocol CaseIterable

A type that provides a collection of all of its values.

protocol Copyable

A type whose values can be implicitly or explicitly copied.

@preconcurrency protocol Enum : Hashable, RawRepresentable, Sendable

Generated enum types conform to this protocol.

protocol Equatable

A type that can be compared for value equality.

protocol Escapable

protocol Hashable : Equatable

A type that can be hashed into a Hasher to produce an integer hash value.

protocol RawRepresentable<RawValue>

A type that can be converted to and from an associated raw value.

protocol Sendable

protocol _ProtoNameProviding

SwiftProtobuf Internal: Common support looking up field names.

init()

init?(rawValue: Int)

static let _protobuf_nameMap: _NameMap

var hashValue: Int { get }

static func != (lhs: Self, rhs: Self) -> Bool

Returns a Boolean value indicating whether two values are not equal.

func hash(into hasher: inout Hasher)