Structureswift-protobuf 1.29.0SwiftProtobuf
Google_Protobuf_Field
A single field of a message type.
struct Google_Protobuf_FieldA single field of a message type.
struct Google_Protobuf_Fieldimport SwiftProtobufSupport library for Swift code generated by protoc-gen-swift.
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol EquatableA type that can be compared for value equality.
protocol Escapableprotocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
@preconcurrency protocol Message : CustomDebugStringConvertible, SendableThe 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@preconcurrency protocol _MessageImplementationBase : Hashable, MessageImplementation base for all messages; not intended for client use.
protocol _ProtoNameProvidingSwiftProtobuf Internal: Common support looking up field names.
init() static let _protobuf_nameMap: _NameMapstatic let protoMessageName: Stringvar cardinality: Google_Protobuf_Field.CardinalityThe field cardinality.
var defaultValue: StringThe string value of the default value of this field. Proto2 syntax only.
var jsonName: StringThe field JSON name.
var kind: Google_Protobuf_Field.KindThe field type.
var name: StringThe field name.
var number: Int32The field number.
var oneofIndex: Int32The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.
var options: [Google_Protobuf_Option]The protocol buffer options.
var packed: BoolWhether to use alternative packed wire representation.
var typeURL: StringThe field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".
var unknownFields: UnknownStoragestatic func == (lhs: Google_Protobuf_Field, rhs: Google_Protobuf_Field) -> Bool mutating func decodeMessage<D>(decoder: inout D) throws where D : Decoder func traverse<V>(visitor: inout V) throws where V : Visitor enum CardinalityWhether a field is optional, required, or repeated.
enum KindBasic field types.
init(jsonString: String, extensions: (any ExtensionMap)? = nil, options: JSONDecodingOptions = JSONDecodingOptions()) throws Creates a new message by decoding the given string containing a serialized message in JSON format.
init(jsonString: String, options: JSONDecodingOptions = 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)? = nil, options: JSONDecodingOptions = JSONDecodingOptions()) throws where Bytes : SwiftProtobufContiguousBytes 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 = JSONDecodingOptions()) throws where Bytes : SwiftProtobufContiguousBytes 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)? = nil, options: JSONDecodingOptions = 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 = 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: Bytes, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws where Bytes : SwiftProtobufContiguousBytes 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)? = nil) throws Creates a new message by decoding the given string containing a serialized message in Protocol Buffer text format.
init(textFormatString: String, options: TextFormatDecodingOptions = TextFormatDecodingOptions(), extensions: (any ExtensionMap)? = nil) 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)? = nil, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws Initialize this message from the provided google.protobuf.Any well-known type.
static func array(fromJSONString jsonString: String, extensions: any ExtensionMap = SimpleExtensionMap(), options: JSONDecodingOptions = 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 jsonString: String, options: JSONDecodingOptions = 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 jsonUTF8Bytes: Bytes, extensions: any ExtensionMap = SimpleExtensionMap(), options: JSONDecodingOptions = JSONDecodingOptions()) throws -> [Self] where Bytes : SwiftProtobufContiguousBytes 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 jsonUTF8Bytes: Bytes, options: JSONDecodingOptions = JSONDecodingOptions()) throws -> [Self] where Bytes : SwiftProtobufContiguousBytes 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 jsonUTF8Data: Data, extensions: any ExtensionMap = SimpleExtensionMap(), options: JSONDecodingOptions = 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 jsonUTF8Data: Data, options: JSONDecodingOptions = 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(_ path: String) -> Bool Checks whether the given path is valid for Message type.
static func jsonString<C>(from collection: C, options: JSONEncodingOptions = JSONEncodingOptions()) throws -> String where Self == C.Element, C : Collection Returns a string containing the JSON serialization of the messages.
static func jsonUTF8Bytes<C, Bytes>(from collection: C, options: JSONEncodingOptions = JSONEncodingOptions()) throws -> Bytes where Self == C.Element, C : Collection, Bytes : SwiftProtobufContiguousBytes Returns a SwiftProtobufContiguousBytes containing the UTF-8 JSON serialization of the messages.
static func jsonUTF8Data<C>(from collection: C, options: JSONEncodingOptions = JSONEncodingOptions()) throws -> Data where Self == C.Element, C : Collection Returns a Data containing the UTF-8 JSON serialization of the messages.
static func with(_ populator: (inout Self) throws -> Void) 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.
var debugDescription: String { get }A description generated by recursively visiting all fields in the message, including messages.
var isInitialized: Bool { get }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.
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 func _protobuf_generated_isEqualTo(other: Self) -> Bool func hash(into hasher: inout Hasher) A hash based on the message’s full contents.
func isEqualTo(message: any Message) -> Bool func jsonString(options: JSONEncodingOptions = JSONEncodingOptions()) throws -> String Returns a string containing the JSON serialization of the message.
func jsonUTF8Bytes<Bytes>(options: JSONEncodingOptions = JSONEncodingOptions()) throws -> Bytes where Bytes : SwiftProtobufContiguousBytes Returns a SwiftProtobufContiguousBytes containing the UTF-8 JSON serialization of the message.
func jsonUTF8Data(options: JSONEncodingOptions = JSONEncodingOptions()) throws -> Data Returns a Data containing the UTF-8 JSON serialization of the message.
mutating func merge(from source: Self, fieldMask: Google_Protobuf_FieldMask, mergeOption: Google_Protobuf_FieldMask.MergeOptions = .init()) throws Merges fields specified in a FieldMask into another message.
mutating func merge<Bytes>(serializedBytes bytes: Bytes, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws where Bytes : SwiftProtobufContiguousBytes Updates the message by decoding the given SwiftProtobufContiguousBytes value containing a serialized message in Protocol Buffer binary format into the receiver.
mutating func merge(serializedData data: Data, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = 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 = false, options: BinaryEncodingOptions = BinaryEncodingOptions()) throws -> Bytes where Bytes : SwiftProtobufContiguousBytes Returns a SwiftProtobufContiguousBytes instance containing the Protocol Buffer binary format serialization of the message.
func serializedData(partial: Bool = false) throws -> Data Returns a Data instance containing the Protocol Buffer binary format serialization of the message.
func serializedData(partial: Bool = false, options: BinaryEncodingOptions = 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.
@discardableResult mutating func trim(keeping fieldMask: Google_Protobuf_FieldMask) -> Bool Removes from ‘message’ any field that is not represented in the given FieldMask. If the FieldMask is empty, does nothing.
init<Bytes>(contiguousBytes bytes: Bytes, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws where Bytes : ContiguousBytes Creates a new message by decoding the given Foundation/ContiguousBytes value containing a serialized message in Protocol Buffer binary format.
init<Bytes>(serializedBytes bytes: Bytes, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws where Bytes : ContiguousBytes Creates a new message by decoding the given Foundation/ContiguousBytes value containing a serialized message in Protocol Buffer binary format.
init(serializedData data: Data, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws Creates a new message by decoding the given Data value containing a serialized message in Protocol Buffer binary format.
mutating func merge<Bytes>(contiguousBytes bytes: Bytes, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws where Bytes : ContiguousBytes Updates the message by decoding the given Foundation/ContiguousBytes value containing a serialized message in Protocol Buffer binary format into the receiver.
mutating func merge<Bytes>(serializedBytes bytes: Bytes, extensions: (any ExtensionMap)? = nil, partial: Bool = false, options: BinaryDecodingOptions = BinaryDecodingOptions()) throws where Bytes : ContiguousBytes Updates the message by decoding the given Foundation/ContiguousBytes value containing a serialized message in Protocol Buffer binary format into the receiver.