public sealed class FieldDescriptorProto : object, IMessage<FieldDescriptorProto>, IEquatable<FieldDescriptorProto>, IDeepCloneable<FieldDescriptorProto>, IBufferMessage, IMessage
Describes a field within a message.
Inheritance
Object >
FieldDescriptorProto
Namespace
Google.Protobuf.Reflection
Assembly
Google.Protobuf.dll
Constructors
FieldDescriptorProto()
public FieldDescriptorProto()
FieldDescriptorProto(FieldDescriptorProto)
public FieldDescriptorProto(FieldDescriptorProto other)
Parameter
Fields
DefaultValueFieldNumber
public const int DefaultValueFieldNumber = null
Field number for the "default_value" field.
ExtendeeFieldNumber
public const int ExtendeeFieldNumber = null
Field number for the "extendee" field.
JsonNameFieldNumber
public const int JsonNameFieldNumber = null
Field number for the "json_name" field.
LabelFieldNumber
public const int LabelFieldNumber = null
Field number for the "label" field.
NameFieldNumber
public const int NameFieldNumber = null
Field number for the "name" field.
NumberFieldNumber
public const int NumberFieldNumber = null
Field number for the "number" field.
OneofIndexFieldNumber
public const int OneofIndexFieldNumber = null
Field number for the "oneof_index" field.
OptionsFieldNumber
public const int OptionsFieldNumber = null
Field number for the "options" field.
Proto3OptionalFieldNumber
public const int Proto3OptionalFieldNumber = null
Field number for the "proto3_optional" field.
TypeFieldNumber
public const int TypeFieldNumber = null
Field number for the "type" field.
TypeNameFieldNumber
public const int TypeNameFieldNumber = null
Field number for the "type_name" field.
Properties
DefaultValue
public string DefaultValue { get; set; }
For numeric types, contains the original text representation of the value.
For booleans, "true" or "false".
For strings, contains the default text contents (not escaped in any way).
For bytes, contains the C escaped value. All bytes >= 128 are escaped.
TODO(kenton): Base-64 encode?
Descriptor
public static MessageDescriptor Descriptor { get; }
Property Value
Extendee
public string Extendee { get; set; }
For extensions, this is the name of the type being extended. It is
resolved in the same manner as type_name.
HasDefaultValue
public bool HasDefaultValue { get; }
Gets whether the "default_value" field is set
HasExtendee
public bool HasExtendee { get; }
Gets whether the "extendee" field is set
HasJsonName
public bool HasJsonName { get; }
Gets whether the "json_name" field is set
HasLabel
public bool HasLabel { get; }
Gets whether the "label" field is set
HasName
public bool HasName { get; }
Gets whether the "name" field is set
HasNumber
public bool HasNumber { get; }
Gets whether the "number" field is set
HasOneofIndex
public bool HasOneofIndex { get; }
Gets whether the "oneof_index" field is set
HasProto3Optional
public bool HasProto3Optional { get; }
Gets whether the "proto3_optional" field is set
HasType
public bool HasType { get; }
Gets whether the "type" field is set
HasTypeName
public bool HasTypeName { get; }
Gets whether the "type_name" field is set
JsonName
public string JsonName { get; set; }
JSON name of this field. The value is set by protocol compiler. If the
user has set a "json_name" option on this field, that option's value
will be used. Otherwise, it's deduced from the field's name by converting
it to camelCase.
Label
public FieldDescriptorProto.Types.Label Label { get; set; }
Property Value
Name
public string Name { get; set; }
Property Value
Number
public int Number { get; set; }
Property Value
OneofIndex
public int OneofIndex { get; set; }
If set, gives the index of a oneof in the containing type's oneof_decl
list. This field is a member of that oneof.
Options
public FieldOptions Options { get; set; }
Property Value
Parser
public static MessageParser<FieldDescriptorProto> Parser { get; }
Property Value
Proto3Optional
public bool Proto3Optional { get; set; }
If true, this is a proto3 "optional". When a proto3 field is optional, it
tracks presence regardless of field type.
When proto3_optional is true, this field must be belong to a oneof to
signal to old proto3 clients that presence is tracked for this field. This
oneof is known as a "synthetic" oneof, and this field must be its sole
member (each proto3 optional field gets its own synthetic oneof). Synthetic
oneofs exist in the descriptor only, and do not generate any API. Synthetic
oneofs must be ordered after all "real" oneofs.
For message fields, proto3_optional doesn't create any semantic change,
since non-repeated message fields always track presence. However it still
indicates the semantic detail of whether the user wrote "optional" or not.
This can be useful for round-tripping the .proto file. For consistency we
give message fields a synthetic oneof also, even though it is not required
to track presence. This is especially important because the parser can't
tell if a field is a message or an enum, so it must always create a
synthetic oneof.
Proto2 optional fields do not set this flag, because they already indicate
optional with LABEL_OPTIONAL.
Type
public FieldDescriptorProto.Types.Type Type { get; set; }
If type_name is set, this need not be set. If both this and type_name
are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
TypeName
public string TypeName { get; set; }
For message and enum types, this is the name of the type. If the name
starts with a '.', it is fully-qualified. Otherwise, C++-like scoping
rules are used to find the type (i.e. first the nested types within this
message are searched, then within the parent, on up to the root
namespace).
Methods
CalculateSize()
public int CalculateSize()
Returns
ClearDefaultValue()
public void ClearDefaultValue()
Clears the value of the "default_value" field
ClearExtendee()
public void ClearExtendee()
Clears the value of the "extendee" field
ClearJsonName()
public void ClearJsonName()
Clears the value of the "json_name" field
ClearLabel()
Clears the value of the "label" field
ClearName()
Clears the value of the "name" field
ClearNumber()
public void ClearNumber()
Clears the value of the "number" field
ClearOneofIndex()
public void ClearOneofIndex()
Clears the value of the "oneof_index" field
ClearProto3Optional()
public void ClearProto3Optional()
Clears the value of the "proto3_optional" field
ClearType()
Clears the value of the "type" field
ClearTypeName()
public void ClearTypeName()
Clears the value of the "type_name" field
Clone()
public FieldDescriptorProto Clone()
Returns
Equals(FieldDescriptorProto)
public bool Equals(FieldDescriptorProto other)
Parameter
Returns
Equals(Object)
public override bool Equals(object other)
Parameter
Returns
GetHashCode()
public override int GetHashCode()
Returns
public void MergeFrom(CodedInputStream input)
Parameter
MergeFrom(FieldDescriptorProto)
public void MergeFrom(FieldDescriptorProto other)
Parameter
ToString()
public override string ToString()
Returns
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Parameter
Explicit Interface Implementations
IBufferMessage.InternalMergeFrom(ref ParseContext)
void IBufferMessage.InternalMergeFrom(ref ParseContext input)
Parameter
IBufferMessage.InternalWriteTo(ref WriteContext)
void IBufferMessage.InternalWriteTo(ref WriteContext output)
Parameter
IMessage.Descriptor
MessageDescriptor IMessage.Descriptor { get; }
Returns
