protocol AnyExtensionField
Core protocols implemented by generated extensions.
protocol AnyMessageExtension
Type-erased MessageExtension field implementation.
protocol Decoder
Abstract protocol used by the generated code to deserialize data.
protocol Enum
Generated enum types conform to this protocol.
protocol ExtensibleMessage
Additional capabilities needed by messages that allow extensions.
protocol ExtensionField
The regular ExtensionField type exposes the value directly.
protocol ExtensionMap
A collection of extension objects.
protocol FieldType
protocol MapKeyType
Marker protocol for types that can be used as map keys
protocol MapValueType
Marker Protocol for types that can be used as map values.
protocol ProtobufAPIVersionCheck
This protocol is expected to be implemented by a fileprivate
type in each source file emitted by protoc-gen-swift
. It effectively creates a binding between the version of the generated code and the version of this library, causing a compile-time error (with reasonable diagnostics) if they are incompatible.
protocol ProtobufAPIVersion_2
An empty protocol that encodes the version of the runtime library.
protocol SwiftProtobufContiguousBytes
Conformance to this protocol gives users a way to provide their own “bag of bytes” types to be used for serialization and deserialization of protobufs. It provides a general interface for bytes since the Swift Standard Library currently does not provide such a protocol.
protocol Visitor
This is the key interface used by the generated traverse()
methods used for serialization. It is implemented by each serialization protocol: Protobuf Binary, Protobuf Text, JSON, and the Hash encoder.
enum AnyUnpackError
Describes errors that can occur when unpacking an Google_Protobuf_Any
message.
struct AsyncMessageSequence<Base, M>
An asynchronous sequence of messages decoded from an asynchronous sequence of bytes.
enum BinaryDecodingError
Describes errors that can occur when decoding a message from binary format.
struct BinaryDecodingOptions
Options for binary decoding.
enum BinaryDelimited
Helper methods for reading/writing messages with a length prefix.
enum BinaryEncodingError
Describes errors that can occur when decoding a message from binary format.
struct BinaryEncodingOptions
Options for binary encoding.
struct ExtensionFieldValueSet
A collection of extension field values on a particular object. This is only used within messages to manage the values of extension fields; it does not need to be very sophisticated.
enum FieldMaskError
Describes errors could happen during FieldMask utilities.
struct Google_Protobuf_Any
Any
contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
struct Google_Protobuf_Api
Api is a light-weight descriptor for an API Interface.
struct Google_Protobuf_BoolValue
Wrapper message for bool
.
struct Google_Protobuf_BytesValue
Wrapper message for bytes
.
struct Google_Protobuf_DescriptorProto
Describes a message type.
struct Google_Protobuf_DoubleValue
Wrapper message for double
.
struct Google_Protobuf_Duration
A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like “day” or “month”. It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.
enum Google_Protobuf_Edition
The full set of known editions.
struct Google_Protobuf_Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
struct Google_Protobuf_Enum
Enum type definition.
struct Google_Protobuf_EnumDescriptorProto
Describes an enum type.
struct Google_Protobuf_EnumOptions
struct Google_Protobuf_EnumValue
Enum value definition.
struct Google_Protobuf_EnumValueDescriptorProto
Describes a value within an enum.
struct Google_Protobuf_EnumValueOptions
struct Google_Protobuf_ExtensionRangeOptions
struct Google_Protobuf_FeatureSet
TODO Enums in C++ gencode (and potentially other languages) are not well scoped. This means that each of the feature enums below can clash with each other. The short names we’ve chosen maximize call-site readability, but leave us very open to this scenario. A future feature will be designed and implemented to handle this, hopefully before we ever hit a conflict here.
struct Google_Protobuf_FeatureSetDefaults
A compiled specification for the defaults of a set of features. These messages are generated from FeatureSet extensions and can be used to seed feature resolution. The resolution with this object becomes a simple search for the closest matching edition, followed by proto merges.
struct Google_Protobuf_Field
A single field of a message type.
struct Google_Protobuf_FieldDescriptorProto
Describes a field within a message.
struct Google_Protobuf_FieldMask
FieldMask
represents a set of symbolic field paths, for example:
struct Google_Protobuf_FieldOptions
struct Google_Protobuf_FileDescriptorProto
Describes a complete .proto file.
struct Google_Protobuf_FileDescriptorSet
The protocol compiler can output a FileDescriptorSet containing the .proto files it parses.
struct Google_Protobuf_FileOptions
struct Google_Protobuf_FloatValue
Wrapper message for float
.
struct Google_Protobuf_GeneratedCodeInfo
Describes the relationship between generated code and its original source file. A GeneratedCodeInfo message is associated with only one generated source file, but may contain references to different source .proto files.
struct Google_Protobuf_Int32Value
Wrapper message for int32
.
struct Google_Protobuf_Int64Value
Wrapper message for int64
.
struct Google_Protobuf_ListValue
ListValue
is a wrapper around a repeated field of values.
struct Google_Protobuf_MessageOptions
struct Google_Protobuf_Method
Method represents a method of an API interface.
struct Google_Protobuf_MethodDescriptorProto
Describes a method of a service.
struct Google_Protobuf_MethodOptions
struct Google_Protobuf_Mixin
Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows:
enum Google_Protobuf_NullValue
NullValue
is a singleton enumeration to represent the null value for the Value
type union.
struct Google_Protobuf_OneofDescriptorProto
Describes a oneof.
struct Google_Protobuf_OneofOptions
struct Google_Protobuf_Option
A protocol buffer option, which can be attached to a message, field, enumeration, etc.
struct Google_Protobuf_ServiceDescriptorProto
Describes a service.
struct Google_Protobuf_ServiceOptions
struct Google_Protobuf_SourceCodeInfo
Encapsulates information about the original source file from which a FileDescriptorProto was generated.
struct Google_Protobuf_SourceContext
SourceContext
represents information about the source of a protobuf element, like the file in which it is defined.
struct Google_Protobuf_StringValue
Wrapper message for string
.
struct Google_Protobuf_Struct
Struct
represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, Struct
might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language.
enum Google_Protobuf_Syntax
The syntax in which a protocol buffer element is defined.
struct Google_Protobuf_Timestamp
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.
struct Google_Protobuf_Type
A protocol buffer message type.
struct Google_Protobuf_UInt32Value
Wrapper message for uint32
.
struct Google_Protobuf_UInt64Value
Wrapper message for uint64
.
struct Google_Protobuf_UninterpretedOption
A message representing a option the parser does not recognize. This only appears in options protos created by the compiler::Parser class. DescriptorPool resolves these when building Descriptor objects. Therefore, options protos in descriptor objects (e.g. returned by Descriptor::options(), or produced by Descriptor::CopyTo()) will never have UninterpretedOptions in them.
struct Google_Protobuf_Value
Value
represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
enum Internal
Functions that are public only because they are used by generated message implementations.
enum JSONDecodingError
JSON decoding errors
struct JSONDecodingOptions
Options for JSONDecoding.
enum JSONEncodingError
Enum constants that identify the particular error.
struct JSONEncodingOptions
Options for JSONEncoding.
class MessageExtension<FieldType, MessageType>
A “Message Extension” relates a particular extension field to a particular message. The generic constraints allow compile-time compatibility checks.
struct OptionalEnumExtensionField<E>
Enum extensions
struct OptionalExtensionField<T>
Singular field
struct OptionalGroupExtensionField<G>
struct OptionalMessageExtensionField<M>
struct PackedEnumExtensionField<E>
Packed Repeated Enum fields
struct PackedExtensionField<T>
Packed Repeated fields
enum PathDecodingError
Describes errors can occure during decoding a proto by path.
struct ProtobufBool
Bool
struct ProtobufBytes
Bytes
struct ProtobufDouble
Double
struct ProtobufFixed32
Fixed32
struct ProtobufFixed64
Fixed64
struct ProtobufFloat
Float traits
struct ProtobufInt32
Int32
struct ProtobufInt64
Int64
struct ProtobufSFixed32
SFixed32
struct ProtobufSFixed64
SFixed64
struct ProtobufSInt32
SInt32
struct ProtobufSInt64
SInt64
struct ProtobufString
String
struct ProtobufUInt32
UInt32
struct ProtobufUInt64
UInt64
struct RepeatedEnumExtensionField<E>
Repeated Enum fields
struct RepeatedExtensionField<T>
Repeated fields
struct RepeatedGroupExtensionField<G>
struct RepeatedMessageExtensionField<M>
struct SimpleExtensionMap
A default implementation of ExtensionMap.
struct SwiftProtobufError
A SwiftProtobuf specific error.
enum TextFormatDecodingError
Protobuf text format decoding errors
struct TextFormatDecodingOptions
Options for TextFormatDecoding.
struct TextFormatEncodingOptions
Options for TextFormatEncoding.
struct UnknownStorage
Contains any unknown fields in a decoded message; that is, fields that were sent on the wire but were not recognized by the generated message implementation or were valid field numbers but with mismatching wire formats (for example, a field encoded as a varint when a fixed32 integer was expected).
struct Version