typepb

package
v1.0.12 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 27, 2024 License: MIT Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Syntax_name = map[int32]string{
		0: "SYNTAX_PROTO2",
		1: "SYNTAX_PROTO3",
	}
	Syntax_value = map[string]int32{
		"SYNTAX_PROTO2": 0,
		"SYNTAX_PROTO3": 1,
	}
)

Enum value maps for Syntax.

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",
	}
	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,
	}
)

Enum value maps for Field_Kind.

View Source
var (
	Field_Cardinality_name = map[int32]string{
		0: "CARDINALITY_UNKNOWN",
		1: "CARDINALITY_OPTIONAL",
		2: "CARDINALITY_REQUIRED",
		3: "CARDINALITY_REPEATED",
	}
	Field_Cardinality_value = map[string]int32{
		"CARDINALITY_UNKNOWN":  0,
		"CARDINALITY_OPTIONAL": 1,
		"CARDINALITY_REQUIRED": 2,
		"CARDINALITY_REPEATED": 3,
	}
)

Enum value maps for Field_Cardinality.

Functions

This section is empty.

Types

type Enum

type Enum struct {

	// Enum type name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Enum value definitions.
	Enumvalue []*EnumValue `protobuf:"bytes,2,rep,name=enumvalue,proto3" json:"enumvalue,omitempty"`
	// Protocol buffer options.
	Options []*Option `protobuf:"bytes,3,rep,name=options,proto3" json:"options,omitempty"`
	// The source context.
	SourceContext *sourcecontextpb.SourceContext `protobuf:"bytes,4,opt,name=source_context,json=sourceContext,proto3" json:"source_context,omitempty"`
	// The source syntax.
	Syntax Syntax `protobuf:"varint,5,opt,name=syntax,proto3,enum=google.protobuf.Syntax" json:"syntax,omitempty"`
	// contains filtered or unexported fields
}

Enum type definition.

func (*Enum) Descriptor deprecated

func (*Enum) Descriptor() ([]byte, []int)

Deprecated: Use Enum.ProtoReflect.Descriptor instead.

func (*Enum) GetEnumvalue

func (x *Enum) GetEnumvalue() []*EnumValue

func (*Enum) GetName

func (x *Enum) GetName() string

func (*Enum) GetOptions

func (x *Enum) GetOptions() []*Option

func (*Enum) GetSourceContext

func (x *Enum) GetSourceContext() *sourcecontextpb.SourceContext

func (*Enum) GetSyntax

func (x *Enum) GetSyntax() Syntax

func (*Enum) ProtoMessage

func (*Enum) ProtoMessage()

func (*Enum) ProtoReflect

func (x *Enum) ProtoReflect() protoreflect.Message

func (*Enum) Reset

func (x *Enum) Reset()

func (*Enum) String

func (x *Enum) String() string

func (*Enum) Validate

func (m *Enum) Validate() error

Validate checks the field values on Enum with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Enum) ValidateAll

func (m *Enum) ValidateAll() error

ValidateAll checks the field values on Enum with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in EnumMultiError, or nil if none found.

type EnumMultiError

type EnumMultiError []error

EnumMultiError is an error wrapping multiple validation errors returned by Enum.ValidateAll() if the designated constraints aren't met.

func (EnumMultiError) AllErrors

func (m EnumMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (EnumMultiError) Error

func (m EnumMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type EnumValidationError

type EnumValidationError struct {
	// contains filtered or unexported fields
}

EnumValidationError is the validation error returned by Enum.Validate if the designated constraints aren't met.

func (EnumValidationError) Cause

func (e EnumValidationError) Cause() error

Cause function returns cause value.

func (EnumValidationError) Error

func (e EnumValidationError) Error() string

Error satisfies the builtin error interface

func (EnumValidationError) ErrorName

func (e EnumValidationError) ErrorName() string

ErrorName returns error name.

func (EnumValidationError) Field

func (e EnumValidationError) Field() string

Field function returns field value.

func (EnumValidationError) Key

func (e EnumValidationError) Key() bool

Key function returns key value.

func (EnumValidationError) Reason

func (e EnumValidationError) Reason() string

Reason function returns reason value.

type EnumValue

type EnumValue struct {

	// Enum value name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Enum value number.
	Number int32 `protobuf:"varint,2,opt,name=number,proto3" json:"number,omitempty"`
	// Protocol buffer options.
	Options []*Option `protobuf:"bytes,3,rep,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

Enum value definition.

func (*EnumValue) Descriptor deprecated

func (*EnumValue) Descriptor() ([]byte, []int)

Deprecated: Use EnumValue.ProtoReflect.Descriptor instead.

func (*EnumValue) GetName

func (x *EnumValue) GetName() string

func (*EnumValue) GetNumber

func (x *EnumValue) GetNumber() int32

func (*EnumValue) GetOptions

func (x *EnumValue) GetOptions() []*Option

func (*EnumValue) ProtoMessage

func (*EnumValue) ProtoMessage()

func (*EnumValue) ProtoReflect

func (x *EnumValue) ProtoReflect() protoreflect.Message

func (*EnumValue) Reset

func (x *EnumValue) Reset()

func (*EnumValue) String

func (x *EnumValue) String() string

func (*EnumValue) Validate

func (m *EnumValue) Validate() error

Validate checks the field values on EnumValue with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*EnumValue) ValidateAll

func (m *EnumValue) ValidateAll() error

ValidateAll checks the field values on EnumValue with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in EnumValueMultiError, or nil if none found.

type EnumValueMultiError

type EnumValueMultiError []error

EnumValueMultiError is an error wrapping multiple validation errors returned by EnumValue.ValidateAll() if the designated constraints aren't met.

func (EnumValueMultiError) AllErrors

func (m EnumValueMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (EnumValueMultiError) Error

func (m EnumValueMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type EnumValueValidationError

type EnumValueValidationError struct {
	// contains filtered or unexported fields
}

EnumValueValidationError is the validation error returned by EnumValue.Validate if the designated constraints aren't met.

func (EnumValueValidationError) Cause

func (e EnumValueValidationError) Cause() error

Cause function returns cause value.

func (EnumValueValidationError) Error

func (e EnumValueValidationError) Error() string

Error satisfies the builtin error interface

func (EnumValueValidationError) ErrorName

func (e EnumValueValidationError) ErrorName() string

ErrorName returns error name.

func (EnumValueValidationError) Field

func (e EnumValueValidationError) Field() string

Field function returns field value.

func (EnumValueValidationError) Key

Key function returns key value.

func (EnumValueValidationError) Reason

func (e EnumValueValidationError) Reason() string

Reason function returns reason value.

type Field

type Field struct {

	// The field type.
	Kind Field_Kind `protobuf:"varint,1,opt,name=kind,proto3,enum=google.protobuf.Field_Kind" json:"kind,omitempty"`
	// The field cardinality.
	Cardinality Field_Cardinality `protobuf:"varint,2,opt,name=cardinality,proto3,enum=google.protobuf.Field_Cardinality" json:"cardinality,omitempty"`
	// The field number.
	Number int32 `protobuf:"varint,3,opt,name=number,proto3" json:"number,omitempty"`
	// The field name.
	Name string `protobuf:"bytes,4,opt,name=name,proto3" 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,proto3" 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,proto3" json:"oneof_index,omitempty"`
	// Whether to use alternative packed wire representation.
	Packed bool `protobuf:"varint,8,opt,name=packed,proto3" json:"packed,omitempty"`
	// The protocol buffer options.
	Options []*Option `protobuf:"bytes,9,rep,name=options,proto3" json:"options,omitempty"`
	// The field JSON name.
	JsonName string `protobuf:"bytes,10,opt,name=json_name,json=jsonName,proto3" 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,proto3" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

A single field of a message type.

func (*Field) Descriptor deprecated

func (*Field) Descriptor() ([]byte, []int)

Deprecated: Use Field.ProtoReflect.Descriptor instead.

func (*Field) GetCardinality

func (x *Field) GetCardinality() Field_Cardinality

func (*Field) GetDefaultValue

func (x *Field) GetDefaultValue() string

func (*Field) GetJsonName

func (x *Field) GetJsonName() string

func (*Field) GetKind

func (x *Field) GetKind() Field_Kind

func (*Field) GetName

func (x *Field) GetName() string

func (*Field) GetNumber

func (x *Field) GetNumber() int32

func (*Field) GetOneofIndex

func (x *Field) GetOneofIndex() int32

func (*Field) GetOptions

func (x *Field) GetOptions() []*Option

func (*Field) GetPacked

func (x *Field) GetPacked() bool

func (*Field) GetTypeUrl

func (x *Field) GetTypeUrl() string

func (*Field) ProtoMessage

func (*Field) ProtoMessage()

func (*Field) ProtoReflect

func (x *Field) ProtoReflect() protoreflect.Message

func (*Field) Reset

func (x *Field) Reset()

func (*Field) String

func (x *Field) String() string

func (*Field) Validate

func (m *Field) Validate() error

Validate checks the field values on Field with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Field) ValidateAll

func (m *Field) ValidateAll() error

ValidateAll checks the field values on Field with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in FieldMultiError, or nil if none found.

type FieldMultiError

type FieldMultiError []error

FieldMultiError is an error wrapping multiple validation errors returned by Field.ValidateAll() if the designated constraints aren't met.

func (FieldMultiError) AllErrors

func (m FieldMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (FieldMultiError) Error

func (m FieldMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type FieldValidationError

type FieldValidationError struct {
	// contains filtered or unexported fields
}

FieldValidationError is the validation error returned by Field.Validate if the designated constraints aren't met.

func (FieldValidationError) Cause

func (e FieldValidationError) Cause() error

Cause function returns cause value.

func (FieldValidationError) Error

func (e FieldValidationError) Error() string

Error satisfies the builtin error interface

func (FieldValidationError) ErrorName

func (e FieldValidationError) ErrorName() string

ErrorName returns error name.

func (FieldValidationError) Field

func (e FieldValidationError) Field() string

Field function returns field value.

func (FieldValidationError) Key

func (e FieldValidationError) Key() bool

Key function returns key value.

func (FieldValidationError) Reason

func (e FieldValidationError) Reason() string

Reason function returns reason value.

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) Descriptor

func (Field_Cardinality) Enum

func (Field_Cardinality) EnumDescriptor deprecated

func (Field_Cardinality) EnumDescriptor() ([]byte, []int)

Deprecated: Use Field_Cardinality.Descriptor instead.

func (Field_Cardinality) Number

func (Field_Cardinality) String

func (x Field_Cardinality) String() string

func (Field_Cardinality) Type

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) Descriptor

func (Field_Kind) Descriptor() protoreflect.EnumDescriptor

func (Field_Kind) Enum

func (x Field_Kind) Enum() *Field_Kind

func (Field_Kind) EnumDescriptor deprecated

func (Field_Kind) EnumDescriptor() ([]byte, []int)

Deprecated: Use Field_Kind.Descriptor instead.

func (Field_Kind) Number

func (x Field_Kind) Number() protoreflect.EnumNumber

func (Field_Kind) String

func (x Field_Kind) String() string

func (Field_Kind) Type

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,proto3" 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 *anypb.Any `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

A protocol buffer option, which can be attached to a message, field, enumeration, etc.

func (*Option) Descriptor deprecated

func (*Option) Descriptor() ([]byte, []int)

Deprecated: Use Option.ProtoReflect.Descriptor instead.

func (*Option) GetName

func (x *Option) GetName() string

func (*Option) GetValue

func (x *Option) GetValue() *anypb.Any

func (*Option) ProtoMessage

func (*Option) ProtoMessage()

func (*Option) ProtoReflect

func (x *Option) ProtoReflect() protoreflect.Message

func (*Option) Reset

func (x *Option) Reset()

func (*Option) String

func (x *Option) String() string

func (*Option) Validate

func (m *Option) Validate() error

Validate checks the field values on Option with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Option) ValidateAll

func (m *Option) ValidateAll() error

ValidateAll checks the field values on Option with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in OptionMultiError, or nil if none found.

type OptionMultiError

type OptionMultiError []error

OptionMultiError is an error wrapping multiple validation errors returned by Option.ValidateAll() if the designated constraints aren't met.

func (OptionMultiError) AllErrors

func (m OptionMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (OptionMultiError) Error

func (m OptionMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type OptionValidationError

type OptionValidationError struct {
	// contains filtered or unexported fields
}

OptionValidationError is the validation error returned by Option.Validate if the designated constraints aren't met.

func (OptionValidationError) Cause

func (e OptionValidationError) Cause() error

Cause function returns cause value.

func (OptionValidationError) Error

func (e OptionValidationError) Error() string

Error satisfies the builtin error interface

func (OptionValidationError) ErrorName

func (e OptionValidationError) ErrorName() string

ErrorName returns error name.

func (OptionValidationError) Field

func (e OptionValidationError) Field() string

Field function returns field value.

func (OptionValidationError) Key

func (e OptionValidationError) Key() bool

Key function returns key value.

func (OptionValidationError) Reason

func (e OptionValidationError) Reason() string

Reason function returns reason value.

type Syntax

type Syntax int32

The syntax in which a protocol buffer element is defined.

const (
	// Syntax `proto2`.
	Syntax_SYNTAX_PROTO2 Syntax = 0
	// Syntax `proto3`.
	Syntax_SYNTAX_PROTO3 Syntax = 1
)

func (Syntax) Descriptor

func (Syntax) Descriptor() protoreflect.EnumDescriptor

func (Syntax) Enum

func (x Syntax) Enum() *Syntax

func (Syntax) EnumDescriptor deprecated

func (Syntax) EnumDescriptor() ([]byte, []int)

Deprecated: Use Syntax.Descriptor instead.

func (Syntax) Number

func (x Syntax) Number() protoreflect.EnumNumber

func (Syntax) String

func (x Syntax) String() string

func (Syntax) Type

func (Syntax) Type() protoreflect.EnumType

type Type

type Type struct {

	// The fully qualified message name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The list of fields.
	Fields []*Field `protobuf:"bytes,2,rep,name=fields,proto3" json:"fields,omitempty"`
	// The list of types appearing in `oneof` definitions in this type.
	Oneofs []string `protobuf:"bytes,3,rep,name=oneofs,proto3" json:"oneofs,omitempty"`
	// The protocol buffer options.
	Options []*Option `protobuf:"bytes,4,rep,name=options,proto3" json:"options,omitempty"`
	// The source context.
	SourceContext *sourcecontextpb.SourceContext `protobuf:"bytes,5,opt,name=source_context,json=sourceContext,proto3" json:"source_context,omitempty"`
	// The source syntax.
	Syntax Syntax `protobuf:"varint,6,opt,name=syntax,proto3,enum=google.protobuf.Syntax" json:"syntax,omitempty"`
	// contains filtered or unexported fields
}

A protocol buffer message type.

func (*Type) Descriptor deprecated

func (*Type) Descriptor() ([]byte, []int)

Deprecated: Use Type.ProtoReflect.Descriptor instead.

func (*Type) GetFields

func (x *Type) GetFields() []*Field

func (*Type) GetName

func (x *Type) GetName() string

func (*Type) GetOneofs

func (x *Type) GetOneofs() []string

func (*Type) GetOptions

func (x *Type) GetOptions() []*Option

func (*Type) GetSourceContext

func (x *Type) GetSourceContext() *sourcecontextpb.SourceContext

func (*Type) GetSyntax

func (x *Type) GetSyntax() Syntax

func (*Type) ProtoMessage

func (*Type) ProtoMessage()

func (*Type) ProtoReflect

func (x *Type) ProtoReflect() protoreflect.Message

func (*Type) Reset

func (x *Type) Reset()

func (*Type) String

func (x *Type) String() string

func (*Type) Validate

func (m *Type) Validate() error

Validate checks the field values on Type with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Type) ValidateAll

func (m *Type) ValidateAll() error

ValidateAll checks the field values on Type with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in TypeMultiError, or nil if none found.

type TypeMultiError

type TypeMultiError []error

TypeMultiError is an error wrapping multiple validation errors returned by Type.ValidateAll() if the designated constraints aren't met.

func (TypeMultiError) AllErrors

func (m TypeMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (TypeMultiError) Error

func (m TypeMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type TypeValidationError

type TypeValidationError struct {
	// contains filtered or unexported fields
}

TypeValidationError is the validation error returned by Type.Validate if the designated constraints aren't met.

func (TypeValidationError) Cause

func (e TypeValidationError) Cause() error

Cause function returns cause value.

func (TypeValidationError) Error

func (e TypeValidationError) Error() string

Error satisfies the builtin error interface

func (TypeValidationError) ErrorName

func (e TypeValidationError) ErrorName() string

ErrorName returns error name.

func (TypeValidationError) Field

func (e TypeValidationError) Field() string

Field function returns field value.

func (TypeValidationError) Key

func (e TypeValidationError) Key() bool

Key function returns key value.

func (TypeValidationError) Reason

func (e TypeValidationError) Reason() string

Reason function returns reason value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL