Documentation ¶
Index ¶
- Variables
- type Alias
- type Block
- func (*Block) Descriptor() ([]byte, []int)deprecated
- func (x *Block) GetAlias() []*Alias
- func (x *Block) GetDescriptionField() string
- func (x *Block) GetName() *Tag
- func (x *Block) GetOnlyExplicit() bool
- func (x *Block) GetQualifier() *Tag
- func (x *Block) GetScalarSplit() *ScalarSplit
- func (x *Block) GetSchemaName() string
- func (x *Block) GetTypeSelect() *Tag
- func (*Block) ProtoMessage()
- func (x *Block) ProtoReflect() protoreflect.Message
- func (x *Block) Reset()
- func (x *Block) String() string
- type Path
- type ScalarSplit
- func (*ScalarSplit) Descriptor() ([]byte, []int)deprecated
- func (x *ScalarSplit) GetDelimiter() string
- func (x *ScalarSplit) GetOptionalFields() []*Path
- func (x *ScalarSplit) GetRemainderField() *Path
- func (x *ScalarSplit) GetRequiredFields() []*Path
- func (x *ScalarSplit) GetRightToLeft() bool
- func (*ScalarSplit) ProtoMessage()
- func (x *ScalarSplit) ProtoReflect() protoreflect.Message
- func (x *ScalarSplit) Reset()
- func (x *ScalarSplit) String() string
- type Schema
- type SchemaFile
- func (*SchemaFile) Descriptor() ([]byte, []int)deprecated
- func (x *SchemaFile) GetSchema() *Schema
- func (x *SchemaFile) GetSourceLocation() *SourceLocation
- func (*SchemaFile) ProtoMessage()
- func (x *SchemaFile) ProtoReflect() protoreflect.Message
- func (x *SchemaFile) Reset()
- func (x *SchemaFile) String() string
- type SourceLocation
- func (*SourceLocation) Descriptor() ([]byte, []int)deprecated
- func (x *SourceLocation) GetChildren() map[string]*SourceLocation
- func (x *SourceLocation) GetEndColumn() int32
- func (x *SourceLocation) GetEndLine() int32
- func (x *SourceLocation) GetStartColumn() int32
- func (x *SourceLocation) GetStartLine() int32
- func (*SourceLocation) ProtoMessage()
- func (x *SourceLocation) ProtoReflect() protoreflect.Message
- func (x *SourceLocation) Reset()
- func (x *SourceLocation) String() string
- type Tag
- func (*Tag) Descriptor() ([]byte, []int)deprecated
- func (x *Tag) GetBangBool() string
- func (x *Tag) GetFieldName() string
- func (x *Tag) GetIsBlock() bool
- func (x *Tag) GetOptional() bool
- func (x *Tag) GetQuestionBool() string
- func (*Tag) ProtoMessage()
- func (x *Tag) ProtoReflect() protoreflect.Message
- func (x *Tag) Reset()
- func (x *Tag) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var File_j5_bcl_v1_annotations_proto protoreflect.FileDescriptor
View Source
var File_j5_bcl_v1_spec_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Alias ¶
type Alias struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Path *Path `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"` // contains filtered or unexported fields }
func (*Alias) Descriptor
deprecated
func (*Alias) ProtoMessage ¶
func (*Alias) ProtoMessage()
func (*Alias) ProtoReflect ¶
func (x *Alias) ProtoReflect() protoreflect.Message
type Block ¶
type Block struct { // The full name (i.e. protoreflect's FullName) of the schema this block // defines. SchemaName string `protobuf:"bytes,1,opt,name=schema_name,json=schemaName,proto3" json:"schema_name,omitempty"` Name *Tag `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` TypeSelect *Tag `protobuf:"bytes,4,opt,name=type_select,json=typeSelect,proto3,oneof" json:"type_select,omitempty"` Qualifier *Tag `protobuf:"bytes,5,opt,name=qualifier,proto3,oneof" json:"qualifier,omitempty"` DescriptionField *string `protobuf:"bytes,6,opt,name=description_field,json=descriptionField,proto3,oneof" json:"description_field,omitempty"` Alias []*Alias `protobuf:"bytes,10,rep,name=alias,proto3" json:"alias,omitempty"` ScalarSplit *ScalarSplit `protobuf:"bytes,8,opt,name=scalar_split,json=scalarSplit,proto3" json:"scalar_split,omitempty"` // When true, fields in the block which are not mentioned in tags or children // are not settable. OnlyExplicit bool `protobuf:"varint,9,opt,name=only_explicit,json=onlyExplicit,proto3" json:"only_explicit,omitempty"` // contains filtered or unexported fields }
func (*Block) Descriptor
deprecated
func (*Block) GetDescriptionField ¶
func (*Block) GetOnlyExplicit ¶
func (*Block) GetQualifier ¶
func (*Block) GetScalarSplit ¶
func (x *Block) GetScalarSplit() *ScalarSplit
func (*Block) GetSchemaName ¶
func (*Block) GetTypeSelect ¶
func (*Block) ProtoMessage ¶
func (*Block) ProtoMessage()
func (*Block) ProtoReflect ¶
func (x *Block) ProtoReflect() protoreflect.Message
type Path ¶
type Path struct { Path []string `protobuf:"bytes,1,rep,name=path,proto3" json:"path,omitempty"` // contains filtered or unexported fields }
A Path is the nested field names from a root node to a child node. All path elements are strings, which is the field names, map keys, or in theory list index string-numbers.
func (*Path) Descriptor
deprecated
func (*Path) ProtoMessage ¶
func (*Path) ProtoMessage()
func (*Path) ProtoReflect ¶
func (x *Path) ProtoReflect() protoreflect.Message
type ScalarSplit ¶
type ScalarSplit struct { Delimiter *string `protobuf:"bytes,1,opt,name=delimiter,proto3,oneof" json:"delimiter,omitempty"` // When the value is a string, split it by this delimiter into array of strings and continue // When true, the first element is the rightmost element, walking left to right. RightToLeft bool `protobuf:"varint,2,opt,name=right_to_left,json=rightToLeft,proto3" json:"right_to_left,omitempty"` // Fields are popped one by one, and set to the values at the paths specified // in required. If there are not enough values, an error is raised. RequiredFields []*Path `protobuf:"bytes,3,rep,name=required_fields,json=requiredFields,proto3" json:"required_fields,omitempty"` // After popping all required fields, the remaining values are added to // optional fields one by one. If we run out of values, that's fine here. OptionalFields []*Path `protobuf:"bytes,4,rep,name=optional_fields,json=optionalFields,proto3" json:"optional_fields,omitempty"` // If there are still remaining values after the optional fields, the // remaining values are concatenated (as strings) using delimiter and all // added to this one field. If there are no remaining values, this field is // not touched. If there are remaining values and this field is not set, an // error is raised. RemainderField *Path `protobuf:"bytes,5,opt,name=remainder_field,json=remainderField,proto3,oneof" json:"remainder_field,omitempty"` // contains filtered or unexported fields }
ScalarSplit is a way to set a block (container/object type) from a scalar, either an array of scalars or a single scalar string.
func (*ScalarSplit) Descriptor
deprecated
func (*ScalarSplit) Descriptor() ([]byte, []int)
Deprecated: Use ScalarSplit.ProtoReflect.Descriptor instead.
func (*ScalarSplit) GetDelimiter ¶
func (x *ScalarSplit) GetDelimiter() string
func (*ScalarSplit) GetOptionalFields ¶
func (x *ScalarSplit) GetOptionalFields() []*Path
func (*ScalarSplit) GetRemainderField ¶
func (x *ScalarSplit) GetRemainderField() *Path
func (*ScalarSplit) GetRequiredFields ¶
func (x *ScalarSplit) GetRequiredFields() []*Path
func (*ScalarSplit) GetRightToLeft ¶
func (x *ScalarSplit) GetRightToLeft() bool
func (*ScalarSplit) ProtoMessage ¶
func (*ScalarSplit) ProtoMessage()
func (*ScalarSplit) ProtoReflect ¶
func (x *ScalarSplit) ProtoReflect() protoreflect.Message
func (*ScalarSplit) Reset ¶
func (x *ScalarSplit) Reset()
func (*ScalarSplit) String ¶
func (x *ScalarSplit) String() string
type Schema ¶
type Schema struct { Blocks []*Block `protobuf:"bytes,1,rep,name=blocks,proto3" json:"blocks,omitempty"` // contains filtered or unexported fields }
func (*Schema) Descriptor
deprecated
func (*Schema) ProtoMessage ¶
func (*Schema) ProtoMessage()
func (*Schema) ProtoReflect ¶
func (x *Schema) ProtoReflect() protoreflect.Message
type SchemaFile ¶
type SchemaFile struct { Schema *Schema `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"` SourceLocation *SourceLocation `protobuf:"bytes,2,opt,name=source_location,json=sourceLocation,proto3" json:"source_location,omitempty"` // contains filtered or unexported fields }
func (*SchemaFile) Descriptor
deprecated
func (*SchemaFile) Descriptor() ([]byte, []int)
Deprecated: Use SchemaFile.ProtoReflect.Descriptor instead.
func (*SchemaFile) GetSchema ¶
func (x *SchemaFile) GetSchema() *Schema
func (*SchemaFile) GetSourceLocation ¶
func (x *SchemaFile) GetSourceLocation() *SourceLocation
func (*SchemaFile) ProtoMessage ¶
func (*SchemaFile) ProtoMessage()
func (*SchemaFile) ProtoReflect ¶
func (x *SchemaFile) ProtoReflect() protoreflect.Message
func (*SchemaFile) Reset ¶
func (x *SchemaFile) Reset()
func (*SchemaFile) String ¶
func (x *SchemaFile) String() string
type SourceLocation ¶
type SourceLocation struct { Children map[string]*SourceLocation `` /* 157-byte string literal not displayed */ StartLine int32 `protobuf:"varint,2,opt,name=start_line,json=startLine,proto3" json:"start_line,omitempty"` StartColumn int32 `protobuf:"varint,3,opt,name=start_column,json=startColumn,proto3" json:"start_column,omitempty"` EndLine int32 `protobuf:"varint,4,opt,name=end_line,json=endLine,proto3" json:"end_line,omitempty"` EndColumn int32 `protobuf:"varint,5,opt,name=end_column,json=endColumn,proto3" json:"end_column,omitempty"` // contains filtered or unexported fields }
func (*SourceLocation) Descriptor
deprecated
func (*SourceLocation) Descriptor() ([]byte, []int)
Deprecated: Use SourceLocation.ProtoReflect.Descriptor instead.
func (*SourceLocation) GetChildren ¶
func (x *SourceLocation) GetChildren() map[string]*SourceLocation
func (*SourceLocation) GetEndColumn ¶
func (x *SourceLocation) GetEndColumn() int32
func (*SourceLocation) GetEndLine ¶
func (x *SourceLocation) GetEndLine() int32
func (*SourceLocation) GetStartColumn ¶
func (x *SourceLocation) GetStartColumn() int32
func (*SourceLocation) GetStartLine ¶
func (x *SourceLocation) GetStartLine() int32
func (*SourceLocation) ProtoMessage ¶
func (*SourceLocation) ProtoMessage()
func (*SourceLocation) ProtoReflect ¶
func (x *SourceLocation) ProtoReflect() protoreflect.Message
func (*SourceLocation) Reset ¶
func (x *SourceLocation) Reset()
func (*SourceLocation) String ¶
func (x *SourceLocation) String() string
type Tag ¶
type Tag struct { FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"` // can use aliases. IsBlock bool `protobuf:"varint,2,opt,name=is_block,json=isBlock,proto3" json:"is_block,omitempty"` Optional bool `protobuf:"varint,3,opt,name=optional,proto3" json:"optional,omitempty"` // When set, a leading '!' on the tag sets a boolean to true at the given // path. (e.g. setting required=true). When not set, bang is illegal. You // shouldn't bang where it's illegal. BangBool *string `protobuf:"bytes,4,opt,name=bang_bool,json=bangBool,proto3,oneof" json:"bang_bool,omitempty"` // Same as bang_bool, but for a ?. Still 'true', e.g. 'optional=true) QuestionBool *string `protobuf:"bytes,5,opt,name=question_bool,json=questionBool,proto3,oneof" json:"question_bool,omitempty"` // contains filtered or unexported fields }
A Tag defines the behavior of the block header components for the type.
func (*Tag) Descriptor
deprecated
func (*Tag) GetBangBool ¶
func (*Tag) GetFieldName ¶
func (*Tag) GetIsBlock ¶
func (*Tag) GetOptional ¶
func (*Tag) GetQuestionBool ¶
func (*Tag) ProtoMessage ¶
func (*Tag) ProtoMessage()
func (*Tag) ProtoReflect ¶
func (x *Tag) ProtoReflect() protoreflect.Message
Click to show internal directories.
Click to hide internal directories.