Google_Protobuf_Value

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 ExpressibleByBooleanLiteral

  A type that can be initialized with the Boolean literals true and false.

• protocol ExpressibleByExtendedGraphemeClusterLiteral

  A type that can be initialized with a string literal containing a single extended grapheme cluster.

• protocol ExpressibleByFloatLiteral

  A type that can be initialized with a floating-point literal.

• protocol ExpressibleByIntegerLiteral

  A type that can be initialized with an integer literal.

• protocol ExpressibleByNilLiteral

  A type that can be initialized using the nil literal, nil.

• protocol ExpressibleByStringLiteral

  A type that can be initialized with a string literal.

• protocol ExpressibleByUnicodeScalarLiteral

  A type that can be initialized with a string literal containing a single Unicode scalar value.

• 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.

Types

• enum OneOf_Kind

  The kind of value.

Typealiases

• typealias BooleanLiteralType
• typealias ExtendedGraphemeClusterLiteralType
• typealias FloatLiteralType
• typealias IntegerLiteralType
• typealias StringLiteralType
• typealias UnicodeScalarLiteralType

Type members

• init()
• init(boolValue: Bool)

  Creates a new Google_Protobuf_Value whose kind is boolValue with the given boolean value.

• init(booleanLiteral: Bool)

  Creates a new Google_Protobuf_Value from a boolean literal.

• init(extendedGraphemeClusterLiteral: String)

  Creates a new Google_Protobuf_Value from a character literal.

• init(floatLiteral: Double)

  Creates a new Google_Protobuf_Value from a floating point literal.

• init(integerLiteral: Int64)

  Creates a new Google_Protobuf_Value from an integer literal.

• init(listValue: Google_Protobuf_ListValue)

  Creates a new Google_Protobuf_Value whose kind is listValue with the given Google_Struct_ListValue value.

• init(nilLiteral: ())

  Creates a new Google_Protobuf_Value from the nil literal.

• init(numberValue: Double)

  Creates a new Google_Protobuf_Value whose kind is numberValue with the given floating-point value.

• init(stringLiteral: String)

  Creates a new Google_Protobuf_Value from a string literal.

• init(stringValue: String)

  Creates a new Google_Protobuf_Value whose kind is stringValue with the given string value.

• init(structValue: Google_Protobuf_Struct)

  Creates a new Google_Protobuf_Value whose kind is structValue with the given Google_Protobuf_Struct value.

• init(unicodeScalarLiteral: String)

  Creates a new Google_Protobuf_Value from a Unicode scalar literal.

• static let protoMessageName: String
• static func == (lhs: Google_Protobuf_Value, rhs: Google_Protobuf_Value) -> Bool

Instance members

• var boolValue: Bool

  Represents a boolean value.

• var kind: Google_Protobuf_Value.OneOf_Kind?

  The kind of value.

• var listValue: Google_Protobuf_ListValue

  Represents a repeated Value.

• var nullValue: Google_Protobuf_NullValue

  Represents a null value.

• var numberValue: Double

  Represents a double value.

• var stringValue: String

  Represents a string value.

• var structValue: Google_Protobuf_Struct

  Represents a structured value.

• var unknownFields: UnknownStorage
• func decodeMessage<D>(decoder: inout D) throws
• func traverse<V>(visitor: inout V) throws

Type features

• init(extendedGraphemeClusterLiteral: Self.StringLiteralType)
• 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(unicodeScalarLiteral: Self.ExtendedGraphemeClusterLiteralType)
• 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

Instance features

• var debugDescription: String

  A description generated by recursively visiting all fields in the message, including messages.

• var isInitialized: Bool

  Generated proto2 messages that contain required fields, nested messages that contain required fields, and/or extensions will provide their own implementation of this property that tests that all required fields are set. Users of the generated code SHOULD NOT override this property.

• 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 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.