Describes a single field of a message. To get the descriptor for a given field, first get the Descriptor for the message in which it is defined, then find the field. To get a FieldDescriptor for an extension, get the Descriptor or FileDescriptor for its containing scope, find the extension.
final class FieldDescriptorimport SwiftProtobufPluginLibraryA reusable framework for building protoc plugins in Swift.
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol Escapableprotocol ProvidesDeprecationCommentProtocol that all the Descriptors conform to provide deprecation comments
protocol ProvidesLocationPathProtocol that all the Descriptors conform to for original .proto file location lookup.
protocol ProvidesSourceCodeLocationProtocol that all the Descriptors conform to for original .proto file location lookup.
var _hasOptionalKeyword: Bool { get }Returns true if this field was syntactically written with “optional” in the .proto file. Excludes singular proto3 fields that do not have a label.
var containingOneof: OneofDescriptor? { get }The oneof this field is a member of.
var containingType: Descriptor! { get }The Descriptor of the message which this is a field of. For extensions, this is the extended type.
let defaultValue: String?The explicitly declared default value for this field.
var enumType: EnumDescriptor! { get }When this is a enum field, that enum’s EnumDescriptor.
var extensionScope: Descriptor? { get }Extensions can be declared within the scope of another message. If this is an extension field, then this will be the scope it was declared in nil if was declared at a global scope.
let features: Google_Protobuf_FeatureSetvar file: FileDescriptor! { get }File in which this field was defined.
var fullName: String { get }Fully-qualified name of the field.
var hasPresence: Bool { get }Returns true if this field tracks presence, ie. does the field distinguish between “unset” and “present with default value.” This includes required, optional, and oneof fields. It excludes maps, repeated fields, and singular proto3 fields without “optional”.
let index: IntIndex of this field within the message’s fields, or the file or extension scope’s extensions.
let isExtension: BoolIf this is an extension field.
var isGroupLike: Bool { get }Helper to see if this is “group-like”. Edition 2024 will likely provide a new feature to better deal with this. See upsteam protobuf for more details on the problem.
var isMap: Bool { get }True if this field is a map.
var isPackable: Bool { get }Is this field packable.
var isPacked: Bool { get }If this field is packable and packed.
var isRepeated: Bool { get }Whether or not the field is repeated/map field.
var isRequired: Bool { get }Whether or not the field is required. For proto2 required fields and Editions LEGACY_REQUIRED fields.
let jsonName: String?JSON name of this field.
var messageType: Descriptor! { get }When this is a message/group field, that message’s Descriptor.
let name: StringName of this field within the message.
let number: Int32The field number.
let oneofIndex: Int32?The index in a oneof this field is in.
var options: Google_Protobuf_FieldOptionsThe FieldOptions for this field.
var realContainingOneof: OneofDescriptor? { get }The non synthetic oneof this field is a member of.
var requiresUTF8Validation: Bool { get }Returns true if this is a string field and should do UTF-8 validation.
var type: Google_Protobuf_FieldDescriptorProto.TypeEnum { get }Declared type of this field.
func deprecationComment(commentPrefix: String) -> String func getLocationPath(path: inout IndexPath) var explicitDefaultValue: String? { get }The explicitly declared default value for this field.
var hasOptionalKeyword: Bool { get }var internal_isGroupLike: Bool { get }TODO: Remove this when it is safe to make breaking changes.
var isOptional: Bool { get }Use !isRequired() && !isRepeated() instead.
var label: Google_Protobuf_FieldDescriptorProto.Label { get }This should never be called directly. Use isRequired and isRepeated helper methods instead.
var oneof: OneofDescriptor? { get }The oneof this field is a member of.
var proto: Google_Protobuf_FieldDescriptorProto { get }var realOneof: OneofDescriptor? { get }The non synthetic oneof this field is a member of.
var sourceCodeInfoLocation: Google_Protobuf_SourceCodeInfo.Location? { get }func protoSourceComments(commentPrefix: String = "///", leadingDetachedPrefix: String? = nil) -> String Helper to get a source comments as a string.
func protoSourceCommentsWithDeprecation(commentPrefix: String = "///", leadingDetachedPrefix: String? = nil) -> String Helper to get the protoSourceComments combined with any depectation comment.