types

Documentation

Index

• Constants
• func BelongToFirstElement(name, prefix string) bool
• func CheckMessageWithOnlyKVFields(md protoreflect.MessageDescriptor) bool
• func IsEnum(text string) bool
• func IsKeyedList(text string) bool
• func IsList(text string) bool
• func IsMap(text string) bool
• func IsScalarType(t string) bool
• func IsStruct(text string) bool
• func IsWellKnownMessage(fullTypeName string) bool
• func MatchBoringInteger(text string) []string
• type Descriptor
  • func ParseTypeDescriptor(rawType string) *Descriptor
• type EnumDescriptor
  • func MatchEnum(text string) *EnumDescriptor
• type KeyedListDescriptor
  • func MatchKeyedList(text string) *KeyedListDescriptor
• type Kind
• type ListDescriptor
  • func MatchList(text string) *ListDescriptor
• type MapDescriptor
  • func MatchMap(text string) *MapDescriptor
• type PropDescriptor
  • func MatchProp(text string) *PropDescriptor
  • func (x *PropDescriptor) FieldProp() (*tableaupb.FieldProp, error)
  • func (x *PropDescriptor) RawProp() string
• type ScalarDescriptor
  • func MatchScalar(text string) *ScalarDescriptor
• type StructDescriptor
  • func MatchStruct(text string) *StructDescriptor

Constants

const (
	WellKnownMessageTimestamp = "google.protobuf.Timestamp"
	WellKnownMessageDuration  = "google.protobuf.Duration"
)

const DefaultDocumentMapKeyOptName = "@key"

const DefaultDocumentMapValueOptName = "@value"

const DefaultListFieldOptNameSuffix = "List"

const DefaultMapFieldOptNameSuffix = "Map"

const DefaultMapKeyOptName = "Key"

const DefaultMapValueOptName = "Value"

const TypeGroup = `(` + nestedTypeCharClass + `*?)`

ungreedy type group

Functions

func BelongToFirstElement

func BelongToFirstElement(name, prefix string) bool

BelongToFirstElement returns true if the name has specified `prefix+"1"` and the next character is not digit.

func CheckMessageWithOnlyKVFields

func CheckMessageWithOnlyKVFields(md protoreflect.MessageDescriptor) bool

func IsEnum

func IsEnum(text string) bool

IsEnum checks if text matches the enum type patterns.

func IsKeyedList

func IsKeyedList(text string) bool

IsKeyedList checks if text matches the keyed list type patterns.

func IsList

func IsList(text string) bool

IsList checks if text matches the list type patterns.

func IsMap

func IsMap(text string) bool

IsMap checks if text matches the map type patterns.

func IsScalarType

func IsScalarType(t string) bool

func IsStruct

func IsStruct(text string) bool

IsStruct checks if text matches the struct type patterns.

func IsWellKnownMessage

func IsWellKnownMessage(fullTypeName string) bool

func MatchBoringInteger

func MatchBoringInteger(text string) []string

Types

type Descriptor

type Descriptor struct {
	Name       string
	FullName   string
	Predefined bool
	Kind       Kind
}

Descriptor describes type metadata.

func ParseTypeDescriptor

func ParseTypeDescriptor(rawType string) *Descriptor

type EnumDescriptor

type EnumDescriptor struct {
	EnumType string
	Prop     PropDescriptor
}

func MatchEnum

func MatchEnum(text string) *EnumDescriptor

MatchEnum matches the enum type pattern. For example:

• enum<Type>
• enum<.PredefinedType>

type KeyedListDescriptor

type KeyedListDescriptor struct {
	ElemType   string
	ColumnType string
	Prop       PropDescriptor
}

func MatchKeyedList

func MatchKeyedList(text string) *KeyedListDescriptor

MatchKeyedList matches the keyed list type patterns. For example:

• [ElemType]<Type>
• [.PredefinedElemType]<Type>

type Kind

type Kind int

const (
	ScalarKind Kind = iota
	EnumKind
	ListKind
	MapKind
	MessageKind
)

type ListDescriptor

type ListDescriptor struct {
	ElemType   string
	ColumnType string
	Prop       PropDescriptor
}

func MatchList

func MatchList(text string) *ListDescriptor

MatchList matches the list type patterns. For example:

• [ElemType]
• [ElemType]Type
• [.PredefinedElemType]Type

type MapDescriptor

type MapDescriptor struct {
	KeyType   string
	ValueType string
	Prop      PropDescriptor
}

func MatchMap

func MatchMap(text string) *MapDescriptor

MatchMap matches the map type patterns. For example:

• map<KeyType, ValueType>
• map<KeyType, .PredefinedValueType>
• map<.PredefinedKeyType, ValueType>
• map<.PredefinedKeyType, .PredefinedValueType>

type PropDescriptor

type PropDescriptor struct {
	Text string // serialized prototext of tableaupb.FieldProp
}

func MatchProp

func MatchProp(text string) *PropDescriptor

func (*PropDescriptor) FieldProp

func (x *PropDescriptor) FieldProp() (*tableaupb.FieldProp, error)

func (*PropDescriptor) RawProp

func (x *PropDescriptor) RawProp() string

type ScalarDescriptor

type ScalarDescriptor struct {
	ScalarType string
	Prop       PropDescriptor
}

func MatchScalar

func MatchScalar(text string) *ScalarDescriptor

MatchScalar matches the scalar type pattern. For example:

• int32
• string

type StructDescriptor

type StructDescriptor struct {
	StructType string
	CustomName string
	ColumnType string
	Prop       PropDescriptor
}

func MatchStruct

func MatchStruct(text string) *StructDescriptor

MatchStruct matches the struct type patterns. For example:

• {StructType}Type
• {StructType(CustomName)}Type
• {.PredefinedStructType}Type
• {.PredefinedStructType(CustomName)}Type