Documentation ¶
Overview ¶
Package ptype is a generated protocol buffer package.
It is generated from these files:
google/protobuf/type.proto
It has these top-level messages:
Type Field Enum EnumValue Option
Index ¶
- Variables
- type Enum
- func (*Enum) Descriptor() ([]byte, []int)
- func (m *Enum) GetEnumvalue() []*EnumValue
- func (m *Enum) GetName() string
- func (m *Enum) GetOptions() []*Option
- func (m *Enum) GetSourceContext() *google_protobuf1.SourceContext
- func (m *Enum) GetSyntax() Syntax
- func (*Enum) ProtoMessage()
- func (m *Enum) Reset()
- func (m *Enum) String() string
- type EnumValue
- type Field
- func (*Field) Descriptor() ([]byte, []int)
- func (m *Field) GetCardinality() Field_Cardinality
- func (m *Field) GetDefaultValue() string
- func (m *Field) GetJsonName() string
- func (m *Field) GetKind() Field_Kind
- func (m *Field) GetName() string
- func (m *Field) GetNumber() int32
- func (m *Field) GetOneofIndex() int32
- func (m *Field) GetOptions() []*Option
- func (m *Field) GetPacked() bool
- func (m *Field) GetTypeUrl() string
- func (*Field) ProtoMessage()
- func (m *Field) Reset()
- func (m *Field) String() string
- type Field_Cardinality
- type Field_Kind
- type Option
- type Syntax
- type Type
- func (*Type) Descriptor() ([]byte, []int)
- func (m *Type) GetFields() []*Field
- func (m *Type) GetName() string
- func (m *Type) GetOneofs() []string
- func (m *Type) GetOptions() []*Option
- func (m *Type) GetSourceContext() *google_protobuf1.SourceContext
- func (m *Type) GetSyntax() Syntax
- func (*Type) ProtoMessage()
- func (m *Type) Reset()
- func (m *Type) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var Field_Cardinality_name = map[int32]string{
0: "CARDINALITY_UNKNOWN",
1: "CARDINALITY_OPTIONAL",
2: "CARDINALITY_REQUIRED",
3: "CARDINALITY_REPEATED",
}
View Source
var Field_Cardinality_value = map[string]int32{
"CARDINALITY_UNKNOWN": 0,
"CARDINALITY_OPTIONAL": 1,
"CARDINALITY_REQUIRED": 2,
"CARDINALITY_REPEATED": 3,
}
View Source
var Field_Kind_name = map[int32]string{
0: "TYPE_UNKNOWN",
1: "TYPE_DOUBLE",
2: "TYPE_FLOAT",
3: "TYPE_INT64",
4: "TYPE_UINT64",
5: "TYPE_INT32",
6: "TYPE_FIXED64",
7: "TYPE_FIXED32",
8: "TYPE_BOOL",
9: "TYPE_STRING",
10: "TYPE_GROUP",
11: "TYPE_MESSAGE",
12: "TYPE_BYTES",
13: "TYPE_UINT32",
14: "TYPE_ENUM",
15: "TYPE_SFIXED32",
16: "TYPE_SFIXED64",
17: "TYPE_SINT32",
18: "TYPE_SINT64",
}
View Source
var Field_Kind_value = map[string]int32{
"TYPE_UNKNOWN": 0,
"TYPE_DOUBLE": 1,
"TYPE_FLOAT": 2,
"TYPE_INT64": 3,
"TYPE_UINT64": 4,
"TYPE_INT32": 5,
"TYPE_FIXED64": 6,
"TYPE_FIXED32": 7,
"TYPE_BOOL": 8,
"TYPE_STRING": 9,
"TYPE_GROUP": 10,
"TYPE_MESSAGE": 11,
"TYPE_BYTES": 12,
"TYPE_UINT32": 13,
"TYPE_ENUM": 14,
"TYPE_SFIXED32": 15,
"TYPE_SFIXED64": 16,
"TYPE_SINT32": 17,
"TYPE_SINT64": 18,
}
View Source
var Syntax_name = map[int32]string{
0: "SYNTAX_PROTO2",
1: "SYNTAX_PROTO3",
}
View Source
var Syntax_value = map[string]int32{
"SYNTAX_PROTO2": 0,
"SYNTAX_PROTO3": 1,
}
Functions ¶
This section is empty.
Types ¶
type Enum ¶
type Enum struct { // Enum type name. Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // Enum value definitions. Enumvalue []*EnumValue `protobuf:"bytes,2,rep,name=enumvalue" json:"enumvalue,omitempty"` // Protocol buffer options. Options []*Option `protobuf:"bytes,3,rep,name=options" json:"options,omitempty"` // The source context. SourceContext *google_protobuf1.SourceContext `protobuf:"bytes,4,opt,name=source_context,json=sourceContext" json:"source_context,omitempty"` // The source syntax. Syntax Syntax `protobuf:"varint,5,opt,name=syntax,enum=google.protobuf.Syntax" json:"syntax,omitempty"` }
Enum type definition.
func (*Enum) Descriptor ¶
func (*Enum) GetEnumvalue ¶
func (*Enum) GetOptions ¶
func (*Enum) GetSourceContext ¶
func (m *Enum) GetSourceContext() *google_protobuf1.SourceContext
func (*Enum) ProtoMessage ¶
func (*Enum) ProtoMessage()
type EnumValue ¶
type EnumValue struct { // Enum value name. Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // Enum value number. Number int32 `protobuf:"varint,2,opt,name=number" json:"number,omitempty"` // Protocol buffer options. Options []*Option `protobuf:"bytes,3,rep,name=options" json:"options,omitempty"` }
Enum value definition.
func (*EnumValue) Descriptor ¶
func (*EnumValue) GetOptions ¶
func (*EnumValue) ProtoMessage ¶
func (*EnumValue) ProtoMessage()
type Field ¶
type Field struct { // The field type. Kind Field_Kind `protobuf:"varint,1,opt,name=kind,enum=google.protobuf.Field_Kind" json:"kind,omitempty"` // The field cardinality. Cardinality Field_Cardinality `protobuf:"varint,2,opt,name=cardinality,enum=google.protobuf.Field_Cardinality" json:"cardinality,omitempty"` // The field number. Number int32 `protobuf:"varint,3,opt,name=number" json:"number,omitempty"` // The field name. Name string `protobuf:"bytes,4,opt,name=name" json:"name,omitempty"` // The field type URL, without the scheme, for message or enumeration // types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. TypeUrl string `protobuf:"bytes,6,opt,name=type_url,json=typeUrl" json:"type_url,omitempty"` // The 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. OneofIndex int32 `protobuf:"varint,7,opt,name=oneof_index,json=oneofIndex" json:"oneof_index,omitempty"` // Whether to use alternative packed wire representation. Packed bool `protobuf:"varint,8,opt,name=packed" json:"packed,omitempty"` // The protocol buffer options. Options []*Option `protobuf:"bytes,9,rep,name=options" json:"options,omitempty"` // The field JSON name. JsonName string `protobuf:"bytes,10,opt,name=json_name,json=jsonName" json:"json_name,omitempty"` // The string value of the default value of this field. Proto2 syntax only. DefaultValue string `protobuf:"bytes,11,opt,name=default_value,json=defaultValue" json:"default_value,omitempty"` }
A single field of a message type.
func (*Field) Descriptor ¶
func (*Field) GetCardinality ¶
func (m *Field) GetCardinality() Field_Cardinality
func (*Field) GetDefaultValue ¶
func (*Field) GetJsonName ¶
func (*Field) GetKind ¶
func (m *Field) GetKind() Field_Kind
func (*Field) GetOneofIndex ¶
func (*Field) GetOptions ¶
func (*Field) GetTypeUrl ¶
func (*Field) ProtoMessage ¶
func (*Field) ProtoMessage()
type Field_Cardinality ¶
type Field_Cardinality int32
Whether a field is optional, required, or repeated.
const ( // For fields with unknown cardinality. Field_CARDINALITY_UNKNOWN Field_Cardinality = 0 // For optional fields. Field_CARDINALITY_OPTIONAL Field_Cardinality = 1 // For required fields. Proto2 syntax only. Field_CARDINALITY_REQUIRED Field_Cardinality = 2 // For repeated fields. Field_CARDINALITY_REPEATED Field_Cardinality = 3 )
func (Field_Cardinality) EnumDescriptor ¶
func (Field_Cardinality) EnumDescriptor() ([]byte, []int)
func (Field_Cardinality) String ¶
func (x Field_Cardinality) String() string
type Field_Kind ¶
type Field_Kind int32
Basic field types.
const ( // Field type unknown. Field_TYPE_UNKNOWN Field_Kind = 0 // Field type double. Field_TYPE_DOUBLE Field_Kind = 1 // Field type float. Field_TYPE_FLOAT Field_Kind = 2 // Field type int64. Field_TYPE_INT64 Field_Kind = 3 // Field type uint64. Field_TYPE_UINT64 Field_Kind = 4 // Field type int32. Field_TYPE_INT32 Field_Kind = 5 // Field type fixed64. Field_TYPE_FIXED64 Field_Kind = 6 // Field type fixed32. Field_TYPE_FIXED32 Field_Kind = 7 // Field type bool. Field_TYPE_BOOL Field_Kind = 8 // Field type string. Field_TYPE_STRING Field_Kind = 9 // Field type group. Proto2 syntax only, and deprecated. Field_TYPE_GROUP Field_Kind = 10 // Field type message. Field_TYPE_MESSAGE Field_Kind = 11 // Field type bytes. Field_TYPE_BYTES Field_Kind = 12 // Field type uint32. Field_TYPE_UINT32 Field_Kind = 13 // Field type enum. Field_TYPE_ENUM Field_Kind = 14 // Field type sfixed32. Field_TYPE_SFIXED32 Field_Kind = 15 // Field type sfixed64. Field_TYPE_SFIXED64 Field_Kind = 16 // Field type sint32. Field_TYPE_SINT32 Field_Kind = 17 // Field type sint64. Field_TYPE_SINT64 Field_Kind = 18 )
func (Field_Kind) EnumDescriptor ¶
func (Field_Kind) EnumDescriptor() ([]byte, []int)
func (Field_Kind) String ¶
func (x Field_Kind) String() string
type Option ¶
type Option struct { // The option's name. For protobuf built-in options (options defined in // descriptor.proto), this is the short name. For example, `"map_entry"`. // For custom options, it should be the fully-qualified name. For example, // `"google.api.http"`. Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // The option's value packed in an Any message. If the value is a primitive, // the corresponding wrapper type defined in google/protobuf/wrappers.proto // should be used. If the value is an enum, it should be stored as an int32 // value using the google.protobuf.Int32Value type. Value *google_protobuf.Any `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"` }
A protocol buffer option, which can be attached to a message, field, enumeration, etc.
func (*Option) Descriptor ¶
func (*Option) GetValue ¶
func (m *Option) GetValue() *google_protobuf.Any
func (*Option) ProtoMessage ¶
func (*Option) ProtoMessage()
type Syntax ¶
type Syntax int32
The syntax in which a protocol buffer element is defined.
func (Syntax) EnumDescriptor ¶
type Type ¶
type Type struct { // The fully qualified message name. Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // The list of fields. Fields []*Field `protobuf:"bytes,2,rep,name=fields" json:"fields,omitempty"` // The list of types appearing in `oneof` definitions in this type. Oneofs []string `protobuf:"bytes,3,rep,name=oneofs" json:"oneofs,omitempty"` // The protocol buffer options. Options []*Option `protobuf:"bytes,4,rep,name=options" json:"options,omitempty"` // The source context. SourceContext *google_protobuf1.SourceContext `protobuf:"bytes,5,opt,name=source_context,json=sourceContext" json:"source_context,omitempty"` // The source syntax. Syntax Syntax `protobuf:"varint,6,opt,name=syntax,enum=google.protobuf.Syntax" json:"syntax,omitempty"` }
A protocol buffer message type.
func (*Type) Descriptor ¶
func (*Type) GetOptions ¶
func (*Type) GetSourceContext ¶
func (m *Type) GetSourceContext() *google_protobuf1.SourceContext
func (*Type) ProtoMessage ¶
func (*Type) ProtoMessage()
Click to show internal directories.
Click to hide internal directories.