Structureswift-protobuf 1.28.1SwiftProtobuf
Google_Protobuf_ExtensionRangeOptions
descriptor.pb.swift:408struct Google_Protobuf_ExtensionRangeOptions
Citizens in SwiftProtobuf
Conformances
protocol CustomDebugStringConvertible
A type with a customized textual representation suitable for debugging purposes.
protocol Equatable
A type that can be compared for value equality.
protocol ExtensibleMessage
Additional capabilities needed by messages that allow extensions.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol Message
The protocol which all generated protobuf messages implement.
Message
is the protocol type you should use whenever you need an argument or variable which holds “some message”.protocol Sendable
A type whose values can safely be passed across concurrency domains by copying.
Show implementation details (2)
Hide implementation details
protocol _MessageImplementationBase
Implementation base for all messages; not intended for client use.
protocol _ProtoNameProviding
SwiftProtobuf Internal: Common support looking up field names.
Types
struct Declaration
enum VerificationState
The verification state of the extension range.
Type members
init(
) static let protoMessageName: String
static func == (lhs: Google_Protobuf_ExtensionRangeOptions, rhs: Google_Protobuf_ExtensionRangeOptions
) -> Bool
Show implementation details (1)
Hide implementation details
Instance members
var declaration: [Google_Protobuf_ExtensionRangeOptions.Declaration]
For external users: DO NOT USE. We are in the process of open sourcing extension declaration and executing internal cleanups before it can be used externally.
var features: Google_Protobuf_FeatureSet
Any features defined in the specific edition.
var hasFeatures: Bool
Returns true if
features
has been explicitly set.var hasVerification: Bool
Returns true if
verification
has been explicitly set.var isInitialized: Bool
var uninterpretedOption: [Google_Protobuf_UninterpretedOption]
The parser stores options it doesn’t recognize here. See above.
var unknownFields: UnknownStorage
var verification: Google_Protobuf_ExtensionRangeOptions.VerificationState
The verification state of the range. TODO: flip the default to DECLARATION once all empty ranges are marked as UNVERIFIED.
func clearFeatures(
) Clears the value of
features
. Subsequent reads from it will return its default value.func clearVerification(
) Clears the value of
verification
. 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)
Hide implementation details
Type features
init(jsonString: String, extensions: (any ExtensionMap)?, options: JSONDecodingOptions
) throws Creates a new message by decoding the given string containing a serialized message in JSON format.
init(jsonString: String, options: JSONDecodingOptions
) throws Creates a new message by decoding the given string containing a serialized message in JSON format.
init<Bytes>(jsonUTF8Bytes: Bytes, extensions: (any ExtensionMap)?, options: JSONDecodingOptions
) throws Creates a new message by decoding the given
SwiftProtobufContiguousBytes
containing a serialized message in JSON format, interpreting the data as UTF-8 encoded text.init<Bytes>(jsonUTF8Bytes: Bytes, options: JSONDecodingOptions
) throws Creates a new message by decoding the given
SwiftProtobufContiguousBytes
containing a serialized message in JSON format, interpreting the data as UTF-8 encoded text.init(jsonUTF8Data: Data, extensions: (any ExtensionMap)?, options: JSONDecodingOptions
) throws Creates a new message by decoding the given
Data
containing a serialized message in JSON format, interpreting the data as UTF-8 encoded text.init(jsonUTF8Data: Data, options: JSONDecodingOptions
) throws Creates a new message by decoding the given
Data
containing a serialized message in JSON format, interpreting the data as UTF-8 encoded text.init<Bytes>(serializedBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Creates a new message by decoding the given
SwiftProtobufContiguousBytes
value containing a serialized message in Protocol Buffer binary format.init(textFormatString: String, extensions: (any ExtensionMap)?
) throws Creates a new message by decoding the given string containing a serialized message in Protocol Buffer text format.
init(textFormatString: String, options: TextFormatDecodingOptions, extensions: (any ExtensionMap)?
) throws Creates a new message by decoding the given string containing a serialized message in Protocol Buffer text format.
init(unpackingAny: Google_Protobuf_Any, extensions: (any ExtensionMap)?, options: BinaryDecodingOptions
) throws Initialize this message from the provided
google.protobuf.Any
well-known type.static func array(fromJSONString: String, extensions: any ExtensionMap, options: JSONDecodingOptions
) throws -> [Self] Creates a new array of messages by decoding the given string containing a serialized array of messages in JSON format.
static func array(fromJSONString: String, options: JSONDecodingOptions
) throws -> [Self] Creates a new array of messages by decoding the given string containing a serialized array of messages in JSON format.
static func array<Bytes>(fromJSONUTF8Bytes: Bytes, extensions: any ExtensionMap, options: JSONDecodingOptions
) throws -> [Self] Creates a new array of messages by decoding the given
SwiftProtobufContiguousBytes
containing a serialized array of messages in JSON format, interpreting the data as UTF-8 encoded text.static func array<Bytes>(fromJSONUTF8Bytes: Bytes, options: JSONDecodingOptions
) throws -> [Self] Creates a new array of messages by decoding the given
SwiftProtobufContiguousBytes
containing a serialized array of messages in JSON format, interpreting the data as UTF-8 encoded text.static func array(fromJSONUTF8Data: Data, extensions: any ExtensionMap, options: JSONDecodingOptions
) throws -> [Self] Creates a new array of messages by decoding the given
Data
containing a serialized array of messages in JSON format, interpreting the data as UTF-8 encoded text.static func array(fromJSONUTF8Data: Data, options: JSONDecodingOptions
) throws -> [Self] Creates a new array of messages by decoding the given
Data
containing a serialized array of messages in JSON format, interpreting the data as UTF-8 encoded text.static func isPathValid(String
) -> Bool Checks whether the given path is valid for Message type.
static func jsonString<C>(from: C, options: JSONEncodingOptions
) throws -> String Returns a string containing the JSON serialization of the messages.
static func jsonUTF8Bytes<C, Bytes>(from: C, options: JSONEncodingOptions
) throws -> Bytes Returns a
SwiftProtobufContiguousBytes
containing the UTF-8 JSON serialization of the messages.static func jsonUTF8Data<C>(from: C, options: JSONEncodingOptions
) throws -> Data Returns a Data containing the UTF-8 JSON serialization of the messages.
static func with((inout Self) throws -> ()
) rethrows -> Self Creates an instance of the message type on which this method is called, executes the given block passing the message in as its sole
inout
argument, and then returns the message.static func != (lhs: Self, rhs: Self
) -> Bool Returns a Boolean value indicating whether two values are not equal.
static func == (lhs: Self, rhs: Self
) -> Bool
Show obsolete interfaces (3)
Hide obsolete interfaces
init<Bytes>(contiguousBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Creates a new message by decoding the given
Foundation/ContiguousBytes
value containing a serialized message in Protocol Buffer binary format.init<Bytes>(serializedBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Creates a new message by decoding the given
Foundation/ContiguousBytes
value containing a serialized message in Protocol Buffer binary format.init(serializedData: Data, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Creates a new message by decoding the given
Data
value containing a serialized message in Protocol Buffer binary format.
Instance features
var debugDescription: String
A description generated by recursively visiting all fields in the message, including messages.
func clearExtensionValue<F>(ext: MessageExtension<F, Self>
) func getExtensionValue<F>(ext: MessageExtension<F, Self>
) -> F.ValueType? func hasExtensionValue<F>(ext: MessageExtension<F, Self>
) -> Bool func hash(into: inout Hasher
) A hash based on the message’s full contents.
func isEqualTo(message: any Message
) -> Bool func jsonString(options: JSONEncodingOptions
) throws -> String Returns a string containing the JSON serialization of the message.
func jsonUTF8Bytes<Bytes>(options: JSONEncodingOptions
) throws -> Bytes Returns a
SwiftProtobufContiguousBytes
containing the UTF-8 JSON serialization of the message.func jsonUTF8Data(options: JSONEncodingOptions
) throws -> Data Returns a Data containing the UTF-8 JSON serialization of the message.
func merge(from: Self, fieldMask: Google_Protobuf_FieldMask, mergeOption: Google_Protobuf_FieldMask.MergeOptions
) throws Merges fields specified in a FieldMask into another message.
func merge<Bytes>(serializedBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Updates the message by decoding the given
SwiftProtobufContiguousBytes
value containing a serialized message in Protocol Buffer binary format into the receiver.func merge(serializedData: Data, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Updates the message by decoding the given
Data
value containing a serialized message in Protocol Buffer binary format into the receiver.func serializedBytes<Bytes>(partial: Bool, options: BinaryEncodingOptions
) throws -> Bytes Returns a
SwiftProtobufContiguousBytes
instance containing the Protocol Buffer binary format serialization of the message.func serializedData(partial: Bool
) throws -> Data Returns a
Data
instance containing the Protocol Buffer binary format serialization of the message.func serializedData(partial: Bool, options: BinaryEncodingOptions
) throws -> Data Returns a
Data
instance containing the Protocol Buffer binary format serialization of the message.func setExtensionValue<E>(ext: MessageExtension<PackedEnumExtensionField<E>, Self>, value: [E]
) func setExtensionValue<E>(ext: MessageExtension<RepeatedEnumExtensionField<E>, Self>, value: [E]
) func setExtensionValue<M>(ext: MessageExtension<RepeatedGroupExtensionField<M>, Self>, value: [M]
) func setExtensionValue<T>(ext: MessageExtension<PackedExtensionField<T>, Self>, value: [T.BaseType]
) func setExtensionValue<T>(ext: MessageExtension<RepeatedExtensionField<T>, Self>, value: [T.BaseType]
) func setExtensionValue<M>(ext: MessageExtension<RepeatedMessageExtensionField<M>, Self>, value: [M]
) func setExtensionValue<F>(ext: MessageExtension<F, Self>, value: F.ValueType
) func textFormatString(
) -> String Returns a string containing the Protocol Buffer text format serialization of the message.
func textFormatString(options: TextFormatEncodingOptions
) -> String Returns a string containing the Protocol Buffer text format serialization of the message.
func trim(keeping: Google_Protobuf_FieldMask
) -> Bool Removes from ‘message’ any field that is not represented in the given FieldMask. If the FieldMask is empty, does nothing.
Show implementation details (1)
Hide implementation details
Show obsolete interfaces (2)
Hide obsolete interfaces
func merge<Bytes>(contiguousBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Updates the message by decoding the given
Foundation/ContiguousBytes
value containing a serialized message in Protocol Buffer binary format into the receiver.func merge<Bytes>(serializedBytes: Bytes, extensions: (any ExtensionMap)?, partial: Bool, options: BinaryDecodingOptions
) throws Updates the message by decoding the given
Foundation/ContiguousBytes
value containing a serialized message in Protocol Buffer binary format into the receiver.