Documentation
¶
Overview ¶
Package xref_proto is a generated protocol buffer package.
It is generated from these files:
kythe/proto/xref.proto
It has these top-level messages:
NodesRequest NodeInfo NodesReply EdgesRequest EdgeSet EdgesReply Location DecorationsRequest DecorationsReply CrossReferencesRequest Anchor Link Printable CrossReferencesReply DocumentationRequest DocumentationReply
Index ¶
- Variables
- func RegisterXRefServiceServer(s *grpc.Server, srv XRefServiceServer)
- type Anchor
- func (*Anchor) Descriptor() ([]byte, []int)
- func (m *Anchor) GetEnd() *Location_Point
- func (m *Anchor) GetSnippetEnd() *Location_Point
- func (m *Anchor) GetSnippetStart() *Location_Point
- func (m *Anchor) GetStart() *Location_Point
- func (m *Anchor) Marshal() (data []byte, err error)
- func (m *Anchor) MarshalTo(data []byte) (int, error)
- func (*Anchor) ProtoMessage()
- func (m *Anchor) Reset()
- func (m *Anchor) Size() (n int)
- func (m *Anchor) String() string
- func (m *Anchor) Unmarshal(data []byte) error
- type CrossReferencesReply
- func (*CrossReferencesReply) Descriptor() ([]byte, []int)
- func (m *CrossReferencesReply) GetCrossReferences() map[string]*CrossReferencesReply_CrossReferenceSet
- func (m *CrossReferencesReply) GetDefinitionLocations() map[string]*Anchor
- func (m *CrossReferencesReply) GetNodes() map[string]*NodeInfo
- func (m *CrossReferencesReply) GetTotal() *CrossReferencesReply_Total
- func (m *CrossReferencesReply) Marshal() (data []byte, err error)
- func (m *CrossReferencesReply) MarshalTo(data []byte) (int, error)
- func (*CrossReferencesReply) ProtoMessage()
- func (m *CrossReferencesReply) Reset()
- func (m *CrossReferencesReply) Size() (n int)
- func (m *CrossReferencesReply) String() string
- func (m *CrossReferencesReply) Unmarshal(data []byte) error
- type CrossReferencesReply_CrossReferenceSet
- func (*CrossReferencesReply_CrossReferenceSet) Descriptor() ([]byte, []int)
- func (m *CrossReferencesReply_CrossReferenceSet) GetCaller() []*CrossReferencesReply_RelatedAnchor
- func (m *CrossReferencesReply_CrossReferenceSet) GetDeclaration() []*CrossReferencesReply_RelatedAnchor
- func (m *CrossReferencesReply_CrossReferenceSet) GetDefinition() []*CrossReferencesReply_RelatedAnchor
- func (m *CrossReferencesReply_CrossReferenceSet) GetDisplayName() *Printable
- func (m *CrossReferencesReply_CrossReferenceSet) GetDocumentation() []*CrossReferencesReply_RelatedAnchor
- func (m *CrossReferencesReply_CrossReferenceSet) GetReference() []*CrossReferencesReply_RelatedAnchor
- func (m *CrossReferencesReply_CrossReferenceSet) GetRelatedNode() []*CrossReferencesReply_RelatedNode
- func (m *CrossReferencesReply_CrossReferenceSet) Marshal() (data []byte, err error)
- func (m *CrossReferencesReply_CrossReferenceSet) MarshalTo(data []byte) (int, error)
- func (*CrossReferencesReply_CrossReferenceSet) ProtoMessage()
- func (m *CrossReferencesReply_CrossReferenceSet) Reset()
- func (m *CrossReferencesReply_CrossReferenceSet) Size() (n int)
- func (m *CrossReferencesReply_CrossReferenceSet) String() string
- func (m *CrossReferencesReply_CrossReferenceSet) Unmarshal(data []byte) error
- type CrossReferencesReply_RelatedAnchor
- func (*CrossReferencesReply_RelatedAnchor) Descriptor() ([]byte, []int)
- func (m *CrossReferencesReply_RelatedAnchor) GetAnchor() *Anchor
- func (m *CrossReferencesReply_RelatedAnchor) GetDisplayName() *Printable
- func (m *CrossReferencesReply_RelatedAnchor) GetSite() []*Anchor
- func (m *CrossReferencesReply_RelatedAnchor) Marshal() (data []byte, err error)
- func (m *CrossReferencesReply_RelatedAnchor) MarshalTo(data []byte) (int, error)
- func (*CrossReferencesReply_RelatedAnchor) ProtoMessage()
- func (m *CrossReferencesReply_RelatedAnchor) Reset()
- func (m *CrossReferencesReply_RelatedAnchor) Size() (n int)
- func (m *CrossReferencesReply_RelatedAnchor) String() string
- func (m *CrossReferencesReply_RelatedAnchor) Unmarshal(data []byte) error
- type CrossReferencesReply_RelatedNode
- func (*CrossReferencesReply_RelatedNode) Descriptor() ([]byte, []int)
- func (m *CrossReferencesReply_RelatedNode) Marshal() (data []byte, err error)
- func (m *CrossReferencesReply_RelatedNode) MarshalTo(data []byte) (int, error)
- func (*CrossReferencesReply_RelatedNode) ProtoMessage()
- func (m *CrossReferencesReply_RelatedNode) Reset()
- func (m *CrossReferencesReply_RelatedNode) Size() (n int)
- func (m *CrossReferencesReply_RelatedNode) String() string
- func (m *CrossReferencesReply_RelatedNode) Unmarshal(data []byte) error
- type CrossReferencesReply_Total
- func (*CrossReferencesReply_Total) Descriptor() ([]byte, []int)
- func (m *CrossReferencesReply_Total) GetRelatedNodesByRelation() map[string]int64
- func (m *CrossReferencesReply_Total) Marshal() (data []byte, err error)
- func (m *CrossReferencesReply_Total) MarshalTo(data []byte) (int, error)
- func (*CrossReferencesReply_Total) ProtoMessage()
- func (m *CrossReferencesReply_Total) Reset()
- func (m *CrossReferencesReply_Total) Size() (n int)
- func (m *CrossReferencesReply_Total) String() string
- func (m *CrossReferencesReply_Total) Unmarshal(data []byte) error
- type CrossReferencesRequest
- func (*CrossReferencesRequest) Descriptor() ([]byte, []int)
- func (m *CrossReferencesRequest) Marshal() (data []byte, err error)
- func (m *CrossReferencesRequest) MarshalTo(data []byte) (int, error)
- func (*CrossReferencesRequest) ProtoMessage()
- func (m *CrossReferencesRequest) Reset()
- func (m *CrossReferencesRequest) Size() (n int)
- func (m *CrossReferencesRequest) String() string
- func (m *CrossReferencesRequest) Unmarshal(data []byte) error
- type CrossReferencesRequest_CallerKind
- type CrossReferencesRequest_DeclarationKind
- type CrossReferencesRequest_DefinitionKind
- type CrossReferencesRequest_DocumentationKind
- type CrossReferencesRequest_ReferenceKind
- type DecorationsReply
- func (*DecorationsReply) Descriptor() ([]byte, []int)
- func (m *DecorationsReply) GetDefinitionLocations() map[string]*Anchor
- func (m *DecorationsReply) GetExtendsOverrides() map[string]*DecorationsReply_Overrides
- func (m *DecorationsReply) GetLocation() *Location
- func (m *DecorationsReply) GetNodes() map[string]*NodeInfo
- func (m *DecorationsReply) GetReference() []*DecorationsReply_Reference
- func (m *DecorationsReply) Marshal() (data []byte, err error)
- func (m *DecorationsReply) MarshalTo(data []byte) (int, error)
- func (*DecorationsReply) ProtoMessage()
- func (m *DecorationsReply) Reset()
- func (m *DecorationsReply) Size() (n int)
- func (m *DecorationsReply) String() string
- func (m *DecorationsReply) Unmarshal(data []byte) error
- type DecorationsReply_Override
- func (*DecorationsReply_Override) Descriptor() ([]byte, []int)
- func (m *DecorationsReply_Override) GetDisplayName() *Printable
- func (m *DecorationsReply_Override) Marshal() (data []byte, err error)
- func (m *DecorationsReply_Override) MarshalTo(data []byte) (int, error)
- func (*DecorationsReply_Override) ProtoMessage()
- func (m *DecorationsReply_Override) Reset()
- func (m *DecorationsReply_Override) Size() (n int)
- func (m *DecorationsReply_Override) String() string
- func (m *DecorationsReply_Override) Unmarshal(data []byte) error
- type DecorationsReply_Override_Kind
- type DecorationsReply_Overrides
- func (*DecorationsReply_Overrides) Descriptor() ([]byte, []int)
- func (m *DecorationsReply_Overrides) GetOverride() []*DecorationsReply_Override
- func (m *DecorationsReply_Overrides) Marshal() (data []byte, err error)
- func (m *DecorationsReply_Overrides) MarshalTo(data []byte) (int, error)
- func (*DecorationsReply_Overrides) ProtoMessage()
- func (m *DecorationsReply_Overrides) Reset()
- func (m *DecorationsReply_Overrides) Size() (n int)
- func (m *DecorationsReply_Overrides) String() string
- func (m *DecorationsReply_Overrides) Unmarshal(data []byte) error
- type DecorationsReply_Reference
- func (*DecorationsReply_Reference) Descriptor() ([]byte, []int)
- func (m *DecorationsReply_Reference) GetAnchorEnd() *Location_Point
- func (m *DecorationsReply_Reference) GetAnchorStart() *Location_Point
- func (m *DecorationsReply_Reference) Marshal() (data []byte, err error)
- func (m *DecorationsReply_Reference) MarshalTo(data []byte) (int, error)
- func (*DecorationsReply_Reference) ProtoMessage()
- func (m *DecorationsReply_Reference) Reset()
- func (m *DecorationsReply_Reference) Size() (n int)
- func (m *DecorationsReply_Reference) String() string
- func (m *DecorationsReply_Reference) Unmarshal(data []byte) error
- type DecorationsRequest
- func (*DecorationsRequest) Descriptor() ([]byte, []int)
- func (m *DecorationsRequest) GetLocation() *Location
- func (m *DecorationsRequest) Marshal() (data []byte, err error)
- func (m *DecorationsRequest) MarshalTo(data []byte) (int, error)
- func (*DecorationsRequest) ProtoMessage()
- func (m *DecorationsRequest) Reset()
- func (m *DecorationsRequest) Size() (n int)
- func (m *DecorationsRequest) String() string
- func (m *DecorationsRequest) Unmarshal(data []byte) error
- type DecorationsRequest_SpanKind
- type DocumentationReply
- func (*DocumentationReply) Descriptor() ([]byte, []int)
- func (m *DocumentationReply) GetDefinitionLocations() map[string]*Anchor
- func (m *DocumentationReply) GetDocument() []*DocumentationReply_Document
- func (m *DocumentationReply) GetNodes() map[string]*NodeInfo
- func (m *DocumentationReply) Marshal() (data []byte, err error)
- func (m *DocumentationReply) MarshalTo(data []byte) (int, error)
- func (*DocumentationReply) ProtoMessage()
- func (m *DocumentationReply) Reset()
- func (m *DocumentationReply) Size() (n int)
- func (m *DocumentationReply) String() string
- func (m *DocumentationReply) Unmarshal(data []byte) error
- type DocumentationReply_Document
- func (*DocumentationReply_Document) Descriptor() ([]byte, []int)
- func (m *DocumentationReply_Document) GetDefinedBy() *Printable
- func (m *DocumentationReply_Document) GetInitializer() *Printable
- func (m *DocumentationReply_Document) GetSignature() *Printable
- func (m *DocumentationReply_Document) GetText() *Printable
- func (m *DocumentationReply_Document) GetType() *Printable
- func (m *DocumentationReply_Document) Marshal() (data []byte, err error)
- func (m *DocumentationReply_Document) MarshalTo(data []byte) (int, error)
- func (*DocumentationReply_Document) ProtoMessage()
- func (m *DocumentationReply_Document) Reset()
- func (m *DocumentationReply_Document) Size() (n int)
- func (m *DocumentationReply_Document) String() string
- func (m *DocumentationReply_Document) Unmarshal(data []byte) error
- type DocumentationRequest
- func (*DocumentationRequest) Descriptor() ([]byte, []int)
- func (m *DocumentationRequest) Marshal() (data []byte, err error)
- func (m *DocumentationRequest) MarshalTo(data []byte) (int, error)
- func (*DocumentationRequest) ProtoMessage()
- func (m *DocumentationRequest) Reset()
- func (m *DocumentationRequest) Size() (n int)
- func (m *DocumentationRequest) String() string
- func (m *DocumentationRequest) Unmarshal(data []byte) error
- type EdgeSet
- func (*EdgeSet) Descriptor() ([]byte, []int)
- func (m *EdgeSet) GetGroups() map[string]*EdgeSet_Group
- func (m *EdgeSet) Marshal() (data []byte, err error)
- func (m *EdgeSet) MarshalTo(data []byte) (int, error)
- func (*EdgeSet) ProtoMessage()
- func (m *EdgeSet) Reset()
- func (m *EdgeSet) Size() (n int)
- func (m *EdgeSet) String() string
- func (m *EdgeSet) Unmarshal(data []byte) error
- type EdgeSet_Group
- func (*EdgeSet_Group) Descriptor() ([]byte, []int)
- func (m *EdgeSet_Group) GetEdge() []*EdgeSet_Group_Edge
- func (m *EdgeSet_Group) Marshal() (data []byte, err error)
- func (m *EdgeSet_Group) MarshalTo(data []byte) (int, error)
- func (*EdgeSet_Group) ProtoMessage()
- func (m *EdgeSet_Group) Reset()
- func (m *EdgeSet_Group) Size() (n int)
- func (m *EdgeSet_Group) String() string
- func (m *EdgeSet_Group) Unmarshal(data []byte) error
- type EdgeSet_Group_Edge
- func (*EdgeSet_Group_Edge) Descriptor() ([]byte, []int)
- func (m *EdgeSet_Group_Edge) Marshal() (data []byte, err error)
- func (m *EdgeSet_Group_Edge) MarshalTo(data []byte) (int, error)
- func (*EdgeSet_Group_Edge) ProtoMessage()
- func (m *EdgeSet_Group_Edge) Reset()
- func (m *EdgeSet_Group_Edge) Size() (n int)
- func (m *EdgeSet_Group_Edge) String() string
- func (m *EdgeSet_Group_Edge) Unmarshal(data []byte) error
- type EdgesReply
- func (*EdgesReply) Descriptor() ([]byte, []int)
- func (m *EdgesReply) GetEdgeSets() map[string]*EdgeSet
- func (m *EdgesReply) GetNodes() map[string]*NodeInfo
- func (m *EdgesReply) GetTotalEdgesByKind() map[string]int64
- func (m *EdgesReply) Marshal() (data []byte, err error)
- func (m *EdgesReply) MarshalTo(data []byte) (int, error)
- func (*EdgesReply) ProtoMessage()
- func (m *EdgesReply) Reset()
- func (m *EdgesReply) Size() (n int)
- func (m *EdgesReply) String() string
- func (m *EdgesReply) Unmarshal(data []byte) error
- type EdgesRequest
- func (*EdgesRequest) Descriptor() ([]byte, []int)
- func (m *EdgesRequest) Marshal() (data []byte, err error)
- func (m *EdgesRequest) MarshalTo(data []byte) (int, error)
- func (*EdgesRequest) ProtoMessage()
- func (m *EdgesRequest) Reset()
- func (m *EdgesRequest) Size() (n int)
- func (m *EdgesRequest) String() string
- func (m *EdgesRequest) Unmarshal(data []byte) error
- type Link
- type Link_Kind
- type Location
- func (*Location) Descriptor() ([]byte, []int)
- func (m *Location) GetEnd() *Location_Point
- func (m *Location) GetStart() *Location_Point
- func (m *Location) Marshal() (data []byte, err error)
- func (m *Location) MarshalTo(data []byte) (int, error)
- func (*Location) ProtoMessage()
- func (m *Location) Reset()
- func (m *Location) Size() (n int)
- func (m *Location) String() string
- func (m *Location) Unmarshal(data []byte) error
- type Location_Kind
- type Location_Point
- func (*Location_Point) Descriptor() ([]byte, []int)
- func (m *Location_Point) Marshal() (data []byte, err error)
- func (m *Location_Point) MarshalTo(data []byte) (int, error)
- func (*Location_Point) ProtoMessage()
- func (m *Location_Point) Reset()
- func (m *Location_Point) Size() (n int)
- func (m *Location_Point) String() string
- func (m *Location_Point) Unmarshal(data []byte) error
- type NodeInfo
- func (*NodeInfo) Descriptor() ([]byte, []int)
- func (m *NodeInfo) GetFacts() map[string][]byte
- func (m *NodeInfo) Marshal() (data []byte, err error)
- func (m *NodeInfo) MarshalTo(data []byte) (int, error)
- func (*NodeInfo) ProtoMessage()
- func (m *NodeInfo) Reset()
- func (m *NodeInfo) Size() (n int)
- func (m *NodeInfo) String() string
- func (m *NodeInfo) Unmarshal(data []byte) error
- type NodesReply
- func (*NodesReply) Descriptor() ([]byte, []int)
- func (m *NodesReply) GetNodes() map[string]*NodeInfo
- func (m *NodesReply) Marshal() (data []byte, err error)
- func (m *NodesReply) MarshalTo(data []byte) (int, error)
- func (*NodesReply) ProtoMessage()
- func (m *NodesReply) Reset()
- func (m *NodesReply) Size() (n int)
- func (m *NodesReply) String() string
- func (m *NodesReply) Unmarshal(data []byte) error
- type NodesRequest
- func (*NodesRequest) Descriptor() ([]byte, []int)
- func (m *NodesRequest) Marshal() (data []byte, err error)
- func (m *NodesRequest) MarshalTo(data []byte) (int, error)
- func (*NodesRequest) ProtoMessage()
- func (m *NodesRequest) Reset()
- func (m *NodesRequest) Size() (n int)
- func (m *NodesRequest) String() string
- func (m *NodesRequest) Unmarshal(data []byte) error
- type Printable
- func (*Printable) Descriptor() ([]byte, []int)
- func (m *Printable) GetLink() []*Link
- func (m *Printable) Marshal() (data []byte, err error)
- func (m *Printable) MarshalTo(data []byte) (int, error)
- func (*Printable) ProtoMessage()
- func (m *Printable) Reset()
- func (m *Printable) Size() (n int)
- func (m *Printable) String() string
- func (m *Printable) Unmarshal(data []byte) error
- type XRefServiceClient
- type XRefServiceServer
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidLengthXref = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowXref = fmt.Errorf("proto: integer overflow") )
var CrossReferencesRequest_CallerKind_name = map[int32]string{
0: "NO_CALLERS",
1: "DIRECT_CALLERS",
2: "OVERRIDE_CALLERS",
}
var CrossReferencesRequest_CallerKind_value = map[string]int32{
"NO_CALLERS": 0,
"DIRECT_CALLERS": 1,
"OVERRIDE_CALLERS": 2,
}
var CrossReferencesRequest_DeclarationKind_name = map[int32]string{
0: "NO_DECLARATIONS",
1: "ALL_DECLARATIONS",
}
var CrossReferencesRequest_DeclarationKind_value = map[string]int32{
"NO_DECLARATIONS": 0,
"ALL_DECLARATIONS": 1,
}
var CrossReferencesRequest_DefinitionKind_name = map[int32]string{
0: "NO_DEFINITIONS",
1: "ALL_DEFINITIONS",
2: "FULL_DEFINITIONS",
3: "BINDING_DEFINITIONS",
}
var CrossReferencesRequest_DefinitionKind_value = map[string]int32{
"NO_DEFINITIONS": 0,
"ALL_DEFINITIONS": 1,
"FULL_DEFINITIONS": 2,
"BINDING_DEFINITIONS": 3,
}
var CrossReferencesRequest_DocumentationKind_name = map[int32]string{
0: "NO_DOCUMENTATION",
1: "ALL_DOCUMENTATION",
}
var CrossReferencesRequest_DocumentationKind_value = map[string]int32{
"NO_DOCUMENTATION": 0,
"ALL_DOCUMENTATION": 1,
}
var CrossReferencesRequest_ReferenceKind_name = map[int32]string{
0: "NO_REFERENCES",
1: "CALL_REFERENCES",
2: "NON_CALL_REFERENCES",
3: "ALL_REFERENCES",
}
var CrossReferencesRequest_ReferenceKind_value = map[string]int32{
"NO_REFERENCES": 0,
"CALL_REFERENCES": 1,
"NON_CALL_REFERENCES": 2,
"ALL_REFERENCES": 3,
}
var DecorationsReply_Override_Kind_name = map[int32]string{
0: "OVERRIDES",
1: "EXTENDS",
}
var DecorationsReply_Override_Kind_value = map[string]int32{
"OVERRIDES": 0,
"EXTENDS": 1,
}
var DecorationsRequest_SpanKind_name = map[int32]string{
0: "WITHIN_SPAN",
1: "AROUND_SPAN",
}
var DecorationsRequest_SpanKind_value = map[string]int32{
"WITHIN_SPAN": 0,
"AROUND_SPAN": 1,
}
var Link_Kind_name = map[int32]string{
0: "DEFINITION",
1: "LIST",
2: "LIST_ITEM",
999: "IMPORTANT",
}
var Link_Kind_value = map[string]int32{
"DEFINITION": 0,
"LIST": 1,
"LIST_ITEM": 2,
"IMPORTANT": 999,
}
var Location_Kind_name = map[int32]string{
0: "FILE",
1: "SPAN",
}
var Location_Kind_value = map[string]int32{
"FILE": 0,
"SPAN": 1,
}
Functions ¶
func RegisterXRefServiceServer ¶
func RegisterXRefServiceServer(s *grpc.Server, srv XRefServiceServer)
Types ¶
type Anchor ¶ added in v0.0.13
type Anchor struct { // Ticket of the anchor node Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"` // Edge kind describing the anchor's relationship with its referenced node Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"` // Parent ticket of the anchor; this is the file containing the anchor Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"` // Starting location of the anchor within its parent's text Start *Location_Point `protobuf:"bytes,4,opt,name=start" json:"start,omitempty"` // Ending location of the anchor within its parent's text End *Location_Point `protobuf:"bytes,5,opt,name=end" json:"end,omitempty"` // The anchor's spanning text within the anchor parent's text Text string `protobuf:"bytes,6,opt,name=text,proto3" json:"text,omitempty"` // User-readable snippet of the anchor parent's text at the location of this // anchor Snippet string `protobuf:"bytes,7,opt,name=snippet,proto3" json:"snippet,omitempty"` // Starting location of the anchor's snippet within its parent's text SnippetStart *Location_Point `protobuf:"bytes,8,opt,name=snippet_start,json=snippetStart" json:"snippet_start,omitempty"` // Ending location of the anchor's snippet within its parent's text SnippetEnd *Location_Point `protobuf:"bytes,9,opt,name=snippet_end,json=snippetEnd" json:"snippet_end,omitempty"` }
func (*Anchor) Descriptor ¶ added in v0.0.21
func (*Anchor) GetEnd ¶ added in v0.0.13
func (m *Anchor) GetEnd() *Location_Point
func (*Anchor) GetSnippetEnd ¶ added in v0.0.16
func (m *Anchor) GetSnippetEnd() *Location_Point
func (*Anchor) GetSnippetStart ¶ added in v0.0.16
func (m *Anchor) GetSnippetStart() *Location_Point
func (*Anchor) GetStart ¶ added in v0.0.13
func (m *Anchor) GetStart() *Location_Point
func (*Anchor) ProtoMessage ¶ added in v0.0.13
func (*Anchor) ProtoMessage()
type CrossReferencesReply ¶ added in v0.0.13
type CrossReferencesReply struct { // Total number of cross-references on all pages matching requested filters. Total *CrossReferencesReply_Total `protobuf:"bytes,5,opt,name=total" json:"total,omitempty"` // Sets of cross-references for each requested node CrossReferences map[string]*CrossReferencesReply_CrossReferenceSet `` /* 180-byte string literal not displayed */ // The facts left from the requested filters of the related node facts Nodes map[string]*NodeInfo `` /* 137-byte string literal not displayed */ // Map from the definition tickets referred to in each NodeInfo to their // Anchor. This map will only be returned if the // CrossReferencesRequest.node_definitions switch is true. DefinitionLocations map[string]*Anchor `` /* 192-byte string literal not displayed */ // If there are additional pages of cross-references after the ones returned // in this reply, next_page_token is the page token that may be passed to // fetch the next page in sequence after this one. If there are no additional // cross-references, this field will be empty. NextPageToken string `protobuf:"bytes,10,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` }
func (*CrossReferencesReply) Descriptor ¶ added in v0.0.21
func (*CrossReferencesReply) Descriptor() ([]byte, []int)
func (*CrossReferencesReply) GetCrossReferences ¶ added in v0.0.13
func (m *CrossReferencesReply) GetCrossReferences() map[string]*CrossReferencesReply_CrossReferenceSet
func (*CrossReferencesReply) GetDefinitionLocations ¶ added in v0.0.21
func (m *CrossReferencesReply) GetDefinitionLocations() map[string]*Anchor
func (*CrossReferencesReply) GetNodes ¶ added in v0.0.13
func (m *CrossReferencesReply) GetNodes() map[string]*NodeInfo
func (*CrossReferencesReply) GetTotal ¶ added in v0.0.25
func (m *CrossReferencesReply) GetTotal() *CrossReferencesReply_Total
func (*CrossReferencesReply) Marshal ¶ added in v0.0.17
func (m *CrossReferencesReply) Marshal() (data []byte, err error)
func (*CrossReferencesReply) MarshalTo ¶ added in v0.0.17
func (m *CrossReferencesReply) MarshalTo(data []byte) (int, error)
func (*CrossReferencesReply) ProtoMessage ¶ added in v0.0.13
func (*CrossReferencesReply) ProtoMessage()
func (*CrossReferencesReply) Reset ¶ added in v0.0.13
func (m *CrossReferencesReply) Reset()
func (*CrossReferencesReply) Size ¶ added in v0.0.17
func (m *CrossReferencesReply) Size() (n int)
func (*CrossReferencesReply) String ¶ added in v0.0.13
func (m *CrossReferencesReply) String() string
func (*CrossReferencesReply) Unmarshal ¶ added in v0.0.17
func (m *CrossReferencesReply) Unmarshal(data []byte) error
type CrossReferencesReply_CrossReferenceSet ¶ added in v0.0.13
type CrossReferencesReply_CrossReferenceSet struct { Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"` // A name for the given node. DisplayName *Printable `protobuf:"bytes,7,opt,name=display_name,json=displayName" json:"display_name,omitempty"` // The set of definitions for the given node. Definition []*CrossReferencesReply_RelatedAnchor `protobuf:"bytes,2,rep,name=definition" json:"definition,omitempty"` // The set of declarations for the given node. Declaration []*CrossReferencesReply_RelatedAnchor `protobuf:"bytes,5,rep,name=declaration" json:"declaration,omitempty"` // The set of simple references for the given node. Reference []*CrossReferencesReply_RelatedAnchor `protobuf:"bytes,3,rep,name=reference" json:"reference,omitempty"` // The set of documentation for the given node. Documentation []*CrossReferencesReply_RelatedAnchor `protobuf:"bytes,4,rep,name=documentation" json:"documentation,omitempty"` // The set of callers for the given node. Caller []*CrossReferencesReply_RelatedAnchor `protobuf:"bytes,6,rep,name=caller" json:"caller,omitempty"` // The set of related nodes to the given node. RelatedNode []*CrossReferencesReply_RelatedNode `protobuf:"bytes,10,rep,name=related_node,json=relatedNode" json:"related_node,omitempty"` }
func (*CrossReferencesReply_CrossReferenceSet) Descriptor ¶ added in v0.0.21
func (*CrossReferencesReply_CrossReferenceSet) Descriptor() ([]byte, []int)
func (*CrossReferencesReply_CrossReferenceSet) GetCaller ¶ added in v0.0.25
func (m *CrossReferencesReply_CrossReferenceSet) GetCaller() []*CrossReferencesReply_RelatedAnchor
func (*CrossReferencesReply_CrossReferenceSet) GetDeclaration ¶ added in v0.0.21
func (m *CrossReferencesReply_CrossReferenceSet) GetDeclaration() []*CrossReferencesReply_RelatedAnchor
func (*CrossReferencesReply_CrossReferenceSet) GetDefinition ¶ added in v0.0.13
func (m *CrossReferencesReply_CrossReferenceSet) GetDefinition() []*CrossReferencesReply_RelatedAnchor
func (*CrossReferencesReply_CrossReferenceSet) GetDisplayName ¶ added in v0.0.25
func (m *CrossReferencesReply_CrossReferenceSet) GetDisplayName() *Printable
func (*CrossReferencesReply_CrossReferenceSet) GetDocumentation ¶ added in v0.0.13
func (m *CrossReferencesReply_CrossReferenceSet) GetDocumentation() []*CrossReferencesReply_RelatedAnchor
func (*CrossReferencesReply_CrossReferenceSet) GetReference ¶ added in v0.0.13
func (m *CrossReferencesReply_CrossReferenceSet) GetReference() []*CrossReferencesReply_RelatedAnchor
func (*CrossReferencesReply_CrossReferenceSet) GetRelatedNode ¶ added in v0.0.13
func (m *CrossReferencesReply_CrossReferenceSet) GetRelatedNode() []*CrossReferencesReply_RelatedNode
func (*CrossReferencesReply_CrossReferenceSet) Marshal ¶ added in v0.0.17
func (m *CrossReferencesReply_CrossReferenceSet) Marshal() (data []byte, err error)
func (*CrossReferencesReply_CrossReferenceSet) MarshalTo ¶ added in v0.0.17
func (m *CrossReferencesReply_CrossReferenceSet) MarshalTo(data []byte) (int, error)
func (*CrossReferencesReply_CrossReferenceSet) ProtoMessage ¶ added in v0.0.13
func (*CrossReferencesReply_CrossReferenceSet) ProtoMessage()
func (*CrossReferencesReply_CrossReferenceSet) Reset ¶ added in v0.0.13
func (m *CrossReferencesReply_CrossReferenceSet) Reset()
func (*CrossReferencesReply_CrossReferenceSet) Size ¶ added in v0.0.17
func (m *CrossReferencesReply_CrossReferenceSet) Size() (n int)
func (*CrossReferencesReply_CrossReferenceSet) String ¶ added in v0.0.13
func (m *CrossReferencesReply_CrossReferenceSet) String() string
func (*CrossReferencesReply_CrossReferenceSet) Unmarshal ¶ added in v0.0.17
func (m *CrossReferencesReply_CrossReferenceSet) Unmarshal(data []byte) error
type CrossReferencesReply_RelatedAnchor ¶ added in v0.0.25
type CrossReferencesReply_RelatedAnchor struct { // The anchor covering the related object. Anchor *Anchor `protobuf:"bytes,1,opt,name=anchor" json:"anchor,omitempty"` // A name for the related object. DisplayName *Printable `protobuf:"bytes,2,opt,name=display_name,json=displayName" json:"display_name,omitempty"` // Specific locations, usually within the related object, that caused // the relationship to exist. This field is relevant to caller sets. Site []*Anchor `protobuf:"bytes,3,rep,name=site" json:"site,omitempty"` // The relevant semantic object. Populated for callers. Ticket string `protobuf:"bytes,4,opt,name=ticket,proto3" json:"ticket,omitempty"` }
func (*CrossReferencesReply_RelatedAnchor) Descriptor ¶ added in v0.0.25
func (*CrossReferencesReply_RelatedAnchor) Descriptor() ([]byte, []int)
func (*CrossReferencesReply_RelatedAnchor) GetAnchor ¶ added in v0.0.25
func (m *CrossReferencesReply_RelatedAnchor) GetAnchor() *Anchor
func (*CrossReferencesReply_RelatedAnchor) GetDisplayName ¶ added in v0.0.25
func (m *CrossReferencesReply_RelatedAnchor) GetDisplayName() *Printable
func (*CrossReferencesReply_RelatedAnchor) GetSite ¶ added in v0.0.25
func (m *CrossReferencesReply_RelatedAnchor) GetSite() []*Anchor
func (*CrossReferencesReply_RelatedAnchor) Marshal ¶ added in v0.0.25
func (m *CrossReferencesReply_RelatedAnchor) Marshal() (data []byte, err error)
func (*CrossReferencesReply_RelatedAnchor) MarshalTo ¶ added in v0.0.25
func (m *CrossReferencesReply_RelatedAnchor) MarshalTo(data []byte) (int, error)
func (*CrossReferencesReply_RelatedAnchor) ProtoMessage ¶ added in v0.0.25
func (*CrossReferencesReply_RelatedAnchor) ProtoMessage()
func (*CrossReferencesReply_RelatedAnchor) Reset ¶ added in v0.0.25
func (m *CrossReferencesReply_RelatedAnchor) Reset()
func (*CrossReferencesReply_RelatedAnchor) Size ¶ added in v0.0.25
func (m *CrossReferencesReply_RelatedAnchor) Size() (n int)
func (*CrossReferencesReply_RelatedAnchor) String ¶ added in v0.0.25
func (m *CrossReferencesReply_RelatedAnchor) String() string
func (*CrossReferencesReply_RelatedAnchor) Unmarshal ¶ added in v0.0.25
func (m *CrossReferencesReply_RelatedAnchor) Unmarshal(data []byte) error
type CrossReferencesReply_RelatedNode ¶ added in v0.0.13
type CrossReferencesReply_RelatedNode struct { // Ticket of the node Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"` // Edge kind describing the node's relation RelationKind string `protobuf:"bytes,2,opt,name=relation_kind,json=relationKind,proto3" json:"relation_kind,omitempty"` // Optional ordinal for edges of the same relation_kind. Ordinal int32 `protobuf:"varint,3,opt,name=ordinal,proto3" json:"ordinal,omitempty"` }
func (*CrossReferencesReply_RelatedNode) Descriptor ¶ added in v0.0.21
func (*CrossReferencesReply_RelatedNode) Descriptor() ([]byte, []int)
func (*CrossReferencesReply_RelatedNode) Marshal ¶ added in v0.0.17
func (m *CrossReferencesReply_RelatedNode) Marshal() (data []byte, err error)
func (*CrossReferencesReply_RelatedNode) MarshalTo ¶ added in v0.0.17
func (m *CrossReferencesReply_RelatedNode) MarshalTo(data []byte) (int, error)
func (*CrossReferencesReply_RelatedNode) ProtoMessage ¶ added in v0.0.13
func (*CrossReferencesReply_RelatedNode) ProtoMessage()
func (*CrossReferencesReply_RelatedNode) Reset ¶ added in v0.0.13
func (m *CrossReferencesReply_RelatedNode) Reset()
func (*CrossReferencesReply_RelatedNode) Size ¶ added in v0.0.17
func (m *CrossReferencesReply_RelatedNode) Size() (n int)
func (*CrossReferencesReply_RelatedNode) String ¶ added in v0.0.13
func (m *CrossReferencesReply_RelatedNode) String() string
func (*CrossReferencesReply_RelatedNode) Unmarshal ¶ added in v0.0.17
func (m *CrossReferencesReply_RelatedNode) Unmarshal(data []byte) error
type CrossReferencesReply_Total ¶ added in v0.0.25
type CrossReferencesReply_Total struct { Definitions int64 `protobuf:"varint,1,opt,name=definitions,proto3" json:"definitions,omitempty"` Declarations int64 `protobuf:"varint,2,opt,name=declarations,proto3" json:"declarations,omitempty"` References int64 `protobuf:"varint,3,opt,name=references,proto3" json:"references,omitempty"` Documentation int64 `protobuf:"varint,4,opt,name=documentation,proto3" json:"documentation,omitempty"` Callers int64 `protobuf:"varint,5,opt,name=callers,proto3" json:"callers,omitempty"` RelatedNodesByRelation map[string]int64 `` /* 213-byte string literal not displayed */ }
func (*CrossReferencesReply_Total) Descriptor ¶ added in v0.0.25
func (*CrossReferencesReply_Total) Descriptor() ([]byte, []int)
func (*CrossReferencesReply_Total) GetRelatedNodesByRelation ¶ added in v0.0.25
func (m *CrossReferencesReply_Total) GetRelatedNodesByRelation() map[string]int64
func (*CrossReferencesReply_Total) Marshal ¶ added in v0.0.25
func (m *CrossReferencesReply_Total) Marshal() (data []byte, err error)
func (*CrossReferencesReply_Total) MarshalTo ¶ added in v0.0.25
func (m *CrossReferencesReply_Total) MarshalTo(data []byte) (int, error)
func (*CrossReferencesReply_Total) ProtoMessage ¶ added in v0.0.25
func (*CrossReferencesReply_Total) ProtoMessage()
func (*CrossReferencesReply_Total) Reset ¶ added in v0.0.25
func (m *CrossReferencesReply_Total) Reset()
func (*CrossReferencesReply_Total) Size ¶ added in v0.0.25
func (m *CrossReferencesReply_Total) Size() (n int)
func (*CrossReferencesReply_Total) String ¶ added in v0.0.25
func (m *CrossReferencesReply_Total) String() string
func (*CrossReferencesReply_Total) Unmarshal ¶ added in v0.0.25
func (m *CrossReferencesReply_Total) Unmarshal(data []byte) error
type CrossReferencesRequest ¶ added in v0.0.13
type CrossReferencesRequest struct { // Set of nodes for which to return their cross-references. Must be // non-empty. Ticket []string `protobuf:"bytes,1,rep,name=ticket" json:"ticket,omitempty"` // Determines what kind of definition anchors, if any, should be returned in // the response. See the documentation for each DefinitionKind for more // information. DefinitionKind CrossReferencesRequest_DefinitionKind `` /* 159-byte string literal not displayed */ // Determines what kind of declaration anchors, if any, should be returned in // the response. See the documentation for each DeclarationKind for more // information. DeclarationKind CrossReferencesRequest_DeclarationKind `` /* 163-byte string literal not displayed */ // Determines what kind of reference anchors, if any, should be returned in // the response. See the documentation for each ReferenceKind for more // information. ReferenceKind CrossReferencesRequest_ReferenceKind `` /* 155-byte string literal not displayed */ // Determines what kind of documentation anchors, if any, should be returned // in the response. See the documentation for each DocumentationKind for more // information. // NOTE: this field is deprecated and will be treated as NO_DOCUMENTATION // in the future. DocumentationKind CrossReferencesRequest_DocumentationKind `` /* 171-byte string literal not displayed */ // Determines what kind of callgraph information, if any, should be returned // in the response. See the documentation for each CallerKind for more // information. CallerKind CrossReferencesRequest_CallerKind `` /* 144-byte string literal not displayed */ // Collection of filter globs that determines which facts will be returned for // the related nodes of each requested node. If filter is empty or unset, no // node facts or related nodes are returned. See EdgesRequest for the format // of the filter globs. Filter []string `protobuf:"bytes,5,rep,name=filter" json:"filter,omitempty"` // Determines whether each Anchor in the response should have its text field // populated. AnchorText bool `protobuf:"varint,6,opt,name=anchor_text,json=anchorText,proto3" json:"anchor_text,omitempty"` // Determines whether each NodeInfo matching the above filters will have its // definition location populated, if known. NodeDefinitions bool `protobuf:"varint,8,opt,name=node_definitions,json=nodeDefinitions,proto3" json:"node_definitions,omitempty"` // Enable the experimental generation of signatures in the // CrossReferencesReply. Enabling this currently causes multiple lookups and // can significantly impact latency. Once latency concerns have been // addressed, this field will be removed and signatures will be returned by // default. // TODO(T156): remove this flag; always enable feature ExperimentalSignatures bool `` /* 130-byte string literal not displayed */ // The cross-references matching a request are organized into logical pages. // The size of each page is a number of distinct cross-references // (definitions, references, documentation, and related nodes). // // If page_token is empty, cross-references will be returned starting at the // beginning of the sequence; otherwise the starting point named by the // page_token will be used. Legal values of page_token are returned by the // server in the next_page_token field of the CrossReferencesReply. A page // token should be treated as an opaque value by the client, and is valid only // relative to a particular CrossReferencesRequest. If an invalid page token // is requested, the server will return an error. // // If page_size > 0, at most that number of cross-references will be returned // by the service for this request (see ReferenceSet and CrossReferencesReply // below). If page_size = 0, the default, the server will assume a reasonable // default page size. The server will return an error if page_size < 0. // // The server is allowed to return fewer cross-references than the requested // page_size, even if more are available, save that it must return at least 1 // edge if any are available at all. PageSize int32 `protobuf:"varint,10,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` PageToken string `protobuf:"bytes,11,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` }
func (*CrossReferencesRequest) Descriptor ¶ added in v0.0.21
func (*CrossReferencesRequest) Descriptor() ([]byte, []int)
func (*CrossReferencesRequest) Marshal ¶ added in v0.0.17
func (m *CrossReferencesRequest) Marshal() (data []byte, err error)
func (*CrossReferencesRequest) MarshalTo ¶ added in v0.0.17
func (m *CrossReferencesRequest) MarshalTo(data []byte) (int, error)
func (*CrossReferencesRequest) ProtoMessage ¶ added in v0.0.13
func (*CrossReferencesRequest) ProtoMessage()
func (*CrossReferencesRequest) Reset ¶ added in v0.0.13
func (m *CrossReferencesRequest) Reset()
func (*CrossReferencesRequest) Size ¶ added in v0.0.17
func (m *CrossReferencesRequest) Size() (n int)
func (*CrossReferencesRequest) String ¶ added in v0.0.13
func (m *CrossReferencesRequest) String() string
func (*CrossReferencesRequest) Unmarshal ¶ added in v0.0.17
func (m *CrossReferencesRequest) Unmarshal(data []byte) error
type CrossReferencesRequest_CallerKind ¶ added in v0.0.25
type CrossReferencesRequest_CallerKind int32
const ( // No callgraph information will be populated in the CrossReferencesReply. CrossReferencesRequest_NO_CALLERS CrossReferencesRequest_CallerKind = 0 // Callgraph information will be populated in the CrossReferencesReply. CrossReferencesRequest_DIRECT_CALLERS CrossReferencesRequest_CallerKind = 1 // Callgraph information will be populated in the CrossReferencesReply. // Calls to override-related functions will also be considered. CrossReferencesRequest_OVERRIDE_CALLERS CrossReferencesRequest_CallerKind = 2 )
func (CrossReferencesRequest_CallerKind) EnumDescriptor ¶ added in v0.0.25
func (CrossReferencesRequest_CallerKind) EnumDescriptor() ([]byte, []int)
func (CrossReferencesRequest_CallerKind) String ¶ added in v0.0.25
func (x CrossReferencesRequest_CallerKind) String() string
type CrossReferencesRequest_DeclarationKind ¶ added in v0.0.21
type CrossReferencesRequest_DeclarationKind int32
const ( // No declarations will be populated in the CrossDeclarationsReply. CrossReferencesRequest_NO_DECLARATIONS CrossReferencesRequest_DeclarationKind = 0 // When the source node is incomplete, all known declaration anchors reached // by the "/kythe/edge/defines" edge kind (or its variants) will be // populated in the CrossDeclarationsReply. CrossReferencesRequest_ALL_DECLARATIONS CrossReferencesRequest_DeclarationKind = 1 )
func (CrossReferencesRequest_DeclarationKind) EnumDescriptor ¶ added in v0.0.21
func (CrossReferencesRequest_DeclarationKind) EnumDescriptor() ([]byte, []int)
func (CrossReferencesRequest_DeclarationKind) String ¶ added in v0.0.21
func (x CrossReferencesRequest_DeclarationKind) String() string
type CrossReferencesRequest_DefinitionKind ¶ added in v0.0.13
type CrossReferencesRequest_DefinitionKind int32
const ( // No definitions will be populated in the CrossReferencesReply. CrossReferencesRequest_NO_DEFINITIONS CrossReferencesRequest_DefinitionKind = 0 // All known definition anchors reached by the "/kythe/edge/defines" edge // kind (or its variants) will be populated in the CrossReferencesReply. CrossReferencesRequest_ALL_DEFINITIONS CrossReferencesRequest_DefinitionKind = 1 // Only definition anchors reached by the "/kythe/edge/defines" edge kind // will be populated in the CrossReferencesReply. CrossReferencesRequest_FULL_DEFINITIONS CrossReferencesRequest_DefinitionKind = 2 // Only definition anchors reached by the "/kythe/edge/defines/binding" edge // kind will be populated in the CrossReferencesReply. CrossReferencesRequest_BINDING_DEFINITIONS CrossReferencesRequest_DefinitionKind = 3 )
func (CrossReferencesRequest_DefinitionKind) EnumDescriptor ¶ added in v0.0.21
func (CrossReferencesRequest_DefinitionKind) EnumDescriptor() ([]byte, []int)
func (CrossReferencesRequest_DefinitionKind) String ¶ added in v0.0.13
func (x CrossReferencesRequest_DefinitionKind) String() string
type CrossReferencesRequest_DocumentationKind ¶ added in v0.0.13
type CrossReferencesRequest_DocumentationKind int32
const ( // No documentation will be populated in the CrossReferencesReply. CrossReferencesRequest_NO_DOCUMENTATION CrossReferencesRequest_DocumentationKind = 0 // All known documentation reached by the "/kythe/edge/documentation" edge // kind (or its variants) will be populated in the CrossReferencesReply. CrossReferencesRequest_ALL_DOCUMENTATION CrossReferencesRequest_DocumentationKind = 1 )
func (CrossReferencesRequest_DocumentationKind) EnumDescriptor ¶ added in v0.0.21
func (CrossReferencesRequest_DocumentationKind) EnumDescriptor() ([]byte, []int)
func (CrossReferencesRequest_DocumentationKind) String ¶ added in v0.0.13
func (x CrossReferencesRequest_DocumentationKind) String() string
type CrossReferencesRequest_ReferenceKind ¶ added in v0.0.13
type CrossReferencesRequest_ReferenceKind int32
const ( // No references will be populated in the CrossReferencesReply. CrossReferencesRequest_NO_REFERENCES CrossReferencesRequest_ReferenceKind = 0 // Only callgraph-related references as described in // http://www.kythe.io/docs/schema/callgraph.html CrossReferencesRequest_CALL_REFERENCES CrossReferencesRequest_ReferenceKind = 1 // All references except those that are related to the callgraph. CrossReferencesRequest_NON_CALL_REFERENCES CrossReferencesRequest_ReferenceKind = 2 // All known reference anchors reached by the "/kythe/edge/ref" edge kind // (or its variants) will be populated in the CrossReferencesReply. CrossReferencesRequest_ALL_REFERENCES CrossReferencesRequest_ReferenceKind = 3 )
func (CrossReferencesRequest_ReferenceKind) EnumDescriptor ¶ added in v0.0.21
func (CrossReferencesRequest_ReferenceKind) EnumDescriptor() ([]byte, []int)
func (CrossReferencesRequest_ReferenceKind) String ¶ added in v0.0.13
func (x CrossReferencesRequest_ReferenceKind) String() string
type DecorationsReply ¶
type DecorationsReply struct { // The normalized location for which decorations are returned. Location *Location `protobuf:"bytes,1,opt,name=location" json:"location,omitempty"` // The encoded source text for the selected window. SourceText []byte `protobuf:"bytes,2,opt,name=source_text,json=sourceText,proto3" json:"source_text,omitempty"` Encoding string `protobuf:"bytes,3,opt,name=encoding,proto3" json:"encoding,omitempty"` // The reference edges located in the specified window. Reference []*DecorationsReply_Reference `protobuf:"bytes,4,rep,name=reference" json:"reference,omitempty"` // This field will contain one entry, keyed by ticket, for each distinct node // referenced by a reference edge that has at least 1 non-filtered fact. Nodes map[string]*NodeInfo `` /* 138-byte string literal not displayed */ // Each anchor cited as a target definition in the references. The map is // keyed by each anchor's ticket. DefinitionLocations map[string]*Anchor `` /* 193-byte string literal not displayed */ // Maps from semantic nodes on the right-hand side of defines/binding // references to the list of their overrides. ExtendsOverrides map[string]*DecorationsReply_Overrides `` /* 184-byte string literal not displayed */ }
func (*DecorationsReply) Descriptor ¶ added in v0.0.21
func (*DecorationsReply) Descriptor() ([]byte, []int)
func (*DecorationsReply) GetDefinitionLocations ¶ added in v0.0.21
func (m *DecorationsReply) GetDefinitionLocations() map[string]*Anchor
func (*DecorationsReply) GetExtendsOverrides ¶ added in v0.0.25
func (m *DecorationsReply) GetExtendsOverrides() map[string]*DecorationsReply_Overrides
func (*DecorationsReply) GetLocation ¶
func (m *DecorationsReply) GetLocation() *Location
func (*DecorationsReply) GetNodes ¶ added in v0.0.22
func (m *DecorationsReply) GetNodes() map[string]*NodeInfo
func (*DecorationsReply) GetReference ¶
func (m *DecorationsReply) GetReference() []*DecorationsReply_Reference
func (*DecorationsReply) Marshal ¶ added in v0.0.17
func (m *DecorationsReply) Marshal() (data []byte, err error)
func (*DecorationsReply) MarshalTo ¶ added in v0.0.17
func (m *DecorationsReply) MarshalTo(data []byte) (int, error)
func (*DecorationsReply) ProtoMessage ¶
func (*DecorationsReply) ProtoMessage()
func (*DecorationsReply) Reset ¶
func (m *DecorationsReply) Reset()
func (*DecorationsReply) Size ¶ added in v0.0.17
func (m *DecorationsReply) Size() (n int)
func (*DecorationsReply) String ¶
func (m *DecorationsReply) String() string
func (*DecorationsReply) Unmarshal ¶ added in v0.0.17
func (m *DecorationsReply) Unmarshal(data []byte) error
type DecorationsReply_Override ¶ added in v0.0.25
type DecorationsReply_Override struct { // The target object. Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"` // The kind of override. Kind DecorationsReply_Override_Kind `protobuf:"varint,2,opt,name=kind,proto3,enum=kythe.proto.DecorationsReply_Override_Kind" json:"kind,omitempty"` // A display name for the object at ticket. DisplayName *Printable `protobuf:"bytes,3,opt,name=display_name,json=displayName" json:"display_name,omitempty"` }
func (*DecorationsReply_Override) Descriptor ¶ added in v0.0.25
func (*DecorationsReply_Override) Descriptor() ([]byte, []int)
func (*DecorationsReply_Override) GetDisplayName ¶ added in v0.0.25
func (m *DecorationsReply_Override) GetDisplayName() *Printable
func (*DecorationsReply_Override) Marshal ¶ added in v0.0.25
func (m *DecorationsReply_Override) Marshal() (data []byte, err error)
func (*DecorationsReply_Override) MarshalTo ¶ added in v0.0.25
func (m *DecorationsReply_Override) MarshalTo(data []byte) (int, error)
func (*DecorationsReply_Override) ProtoMessage ¶ added in v0.0.25
func (*DecorationsReply_Override) ProtoMessage()
func (*DecorationsReply_Override) Reset ¶ added in v0.0.25
func (m *DecorationsReply_Override) Reset()
func (*DecorationsReply_Override) Size ¶ added in v0.0.25
func (m *DecorationsReply_Override) Size() (n int)
func (*DecorationsReply_Override) String ¶ added in v0.0.25
func (m *DecorationsReply_Override) String() string
func (*DecorationsReply_Override) Unmarshal ¶ added in v0.0.25
func (m *DecorationsReply_Override) Unmarshal(data []byte) error
type DecorationsReply_Override_Kind ¶ added in v0.0.25
type DecorationsReply_Override_Kind int32
What kind of override this is.
const ( DecorationsReply_Override_OVERRIDES DecorationsReply_Override_Kind = 0 DecorationsReply_Override_EXTENDS DecorationsReply_Override_Kind = 1 )
func (DecorationsReply_Override_Kind) EnumDescriptor ¶ added in v0.0.25
func (DecorationsReply_Override_Kind) EnumDescriptor() ([]byte, []int)
func (DecorationsReply_Override_Kind) String ¶ added in v0.0.25
func (x DecorationsReply_Override_Kind) String() string
type DecorationsReply_Overrides ¶ added in v0.0.25
type DecorationsReply_Overrides struct {
Override []*DecorationsReply_Override `protobuf:"bytes,1,rep,name=override" json:"override,omitempty"`
}
func (*DecorationsReply_Overrides) Descriptor ¶ added in v0.0.25
func (*DecorationsReply_Overrides) Descriptor() ([]byte, []int)
func (*DecorationsReply_Overrides) GetOverride ¶ added in v0.0.25
func (m *DecorationsReply_Overrides) GetOverride() []*DecorationsReply_Override
func (*DecorationsReply_Overrides) Marshal ¶ added in v0.0.25
func (m *DecorationsReply_Overrides) Marshal() (data []byte, err error)
func (*DecorationsReply_Overrides) MarshalTo ¶ added in v0.0.25
func (m *DecorationsReply_Overrides) MarshalTo(data []byte) (int, error)
func (*DecorationsReply_Overrides) ProtoMessage ¶ added in v0.0.25
func (*DecorationsReply_Overrides) ProtoMessage()
func (*DecorationsReply_Overrides) Reset ¶ added in v0.0.25
func (m *DecorationsReply_Overrides) Reset()
func (*DecorationsReply_Overrides) Size ¶ added in v0.0.25
func (m *DecorationsReply_Overrides) Size() (n int)
func (*DecorationsReply_Overrides) String ¶ added in v0.0.25
func (m *DecorationsReply_Overrides) String() string
func (*DecorationsReply_Overrides) Unmarshal ¶ added in v0.0.25
func (m *DecorationsReply_Overrides) Unmarshal(data []byte) error
type DecorationsReply_Reference ¶
type DecorationsReply_Reference struct { SourceTicket string `protobuf:"bytes,1,opt,name=source_ticket,json=sourceTicket,proto3" json:"source_ticket,omitempty"` TargetTicket string `protobuf:"bytes,2,opt,name=target_ticket,json=targetTicket,proto3" json:"target_ticket,omitempty"` Kind string `protobuf:"bytes,3,opt,name=kind,proto3" json:"kind,omitempty"` // Starting byte offset of this references's anchor (source_ticket) span. AnchorStart *Location_Point `protobuf:"bytes,10,opt,name=anchor_start,json=anchorStart" json:"anchor_start,omitempty"` // Ending byte offset of this references's anchor (source_ticket) span. AnchorEnd *Location_Point `protobuf:"bytes,11,opt,name=anchor_end,json=anchorEnd" json:"anchor_end,omitempty"` // Anchor ticket of the target's definition. Populated only if // target_definitions is true in the DecorationsRequest and the target has // a single unambiguous definition. For each ticket, an Anchor will be // populated in the top-level definition_locations map. TargetDefinition string `protobuf:"bytes,4,opt,name=target_definition,json=targetDefinition,proto3" json:"target_definition,omitempty"` }
Represents a reference edge source ---KIND---> target. Each source is an anchor within the requested source location.
func (*DecorationsReply_Reference) Descriptor ¶ added in v0.0.21
func (*DecorationsReply_Reference) Descriptor() ([]byte, []int)
func (*DecorationsReply_Reference) GetAnchorEnd ¶ added in v0.0.9
func (m *DecorationsReply_Reference) GetAnchorEnd() *Location_Point
func (*DecorationsReply_Reference) GetAnchorStart ¶ added in v0.0.9
func (m *DecorationsReply_Reference) GetAnchorStart() *Location_Point
func (*DecorationsReply_Reference) Marshal ¶ added in v0.0.17
func (m *DecorationsReply_Reference) Marshal() (data []byte, err error)
func (*DecorationsReply_Reference) MarshalTo ¶ added in v0.0.17
func (m *DecorationsReply_Reference) MarshalTo(data []byte) (int, error)
func (*DecorationsReply_Reference) ProtoMessage ¶
func (*DecorationsReply_Reference) ProtoMessage()
func (*DecorationsReply_Reference) Reset ¶
func (m *DecorationsReply_Reference) Reset()
func (*DecorationsReply_Reference) Size ¶ added in v0.0.17
func (m *DecorationsReply_Reference) Size() (n int)
func (*DecorationsReply_Reference) String ¶
func (m *DecorationsReply_Reference) String() string
func (*DecorationsReply_Reference) Unmarshal ¶ added in v0.0.17
func (m *DecorationsReply_Reference) Unmarshal(data []byte) error
type DecorationsRequest ¶
type DecorationsRequest struct { // The location of the file to fetch decorations for. The ticket of location // must be non-empty. It is an error in any case if location is invalid. Location *Location `protobuf:"bytes,1,opt,name=location" json:"location,omitempty"` // How to treat SPAN locations. SpanKind DecorationsRequest_SpanKind `` /* 132-byte string literal not displayed */ // If dirty_buffer is non-empty, the results will be adjusted (patched) to // account for the regions of the specified file differing from the contents // of the dirty buffer. DirtyBuffer []byte `protobuf:"bytes,2,opt,name=dirty_buffer,json=dirtyBuffer,proto3" json:"dirty_buffer,omitempty"` // If true, return the encoded source text for the selected window. Source // text is not affected by patching. SourceText bool `protobuf:"varint,3,opt,name=source_text,json=sourceText,proto3" json:"source_text,omitempty"` // If true, return reference edges whose source nodes are located in the // selected window. References are affected by patching. References bool `protobuf:"varint,4,opt,name=references,proto3" json:"references,omitempty"` // If true, return definition locations, if possible, for each returned // reference target in the DecorationsReply. TargetDefinitions bool `protobuf:"varint,6,opt,name=target_definitions,json=targetDefinitions,proto3" json:"target_definitions,omitempty"` // A collection of filter globs that specify which facts (by name) should be // returned for each node. If filter is empty or unset, no node facts are // returned. The filter applies to ALL referenced nodes. See EdgesRequest // for the format of the filter globs. Filter []string `protobuf:"bytes,5,rep,name=filter" json:"filter,omitempty"` // If true, for every defines/binding Reference in the reply, a NodeInfo // will be provided for each node that Reference extends or overrides. // Furthermore, if definition_locations is true, the response's // definition_locations field will include (where possible) the locations of // the definitions of the nodes that are extended or overridden. ExtendsOverrides bool `protobuf:"varint,7,opt,name=extends_overrides,json=extendsOverrides,proto3" json:"extends_overrides,omitempty"` }
func (*DecorationsRequest) Descriptor ¶ added in v0.0.21
func (*DecorationsRequest) Descriptor() ([]byte, []int)
func (*DecorationsRequest) GetLocation ¶
func (m *DecorationsRequest) GetLocation() *Location
func (*DecorationsRequest) Marshal ¶ added in v0.0.17
func (m *DecorationsRequest) Marshal() (data []byte, err error)
func (*DecorationsRequest) MarshalTo ¶ added in v0.0.17
func (m *DecorationsRequest) MarshalTo(data []byte) (int, error)
func (*DecorationsRequest) ProtoMessage ¶
func (*DecorationsRequest) ProtoMessage()
func (*DecorationsRequest) Reset ¶
func (m *DecorationsRequest) Reset()
func (*DecorationsRequest) Size ¶ added in v0.0.17
func (m *DecorationsRequest) Size() (n int)
func (*DecorationsRequest) String ¶
func (m *DecorationsRequest) String() string
func (*DecorationsRequest) Unmarshal ¶ added in v0.0.17
func (m *DecorationsRequest) Unmarshal(data []byte) error
type DecorationsRequest_SpanKind ¶ added in v0.0.21
type DecorationsRequest_SpanKind int32
const ( // If the location is a SPAN, only decorations contained within the // specified window of the file are returned. This is the default behavior. DecorationsRequest_WITHIN_SPAN DecorationsRequest_SpanKind = 0 // If the location is a SPAN, any decorations that surround it are returned. DecorationsRequest_AROUND_SPAN DecorationsRequest_SpanKind = 1 )
func (DecorationsRequest_SpanKind) EnumDescriptor ¶ added in v0.0.21
func (DecorationsRequest_SpanKind) EnumDescriptor() ([]byte, []int)
func (DecorationsRequest_SpanKind) String ¶ added in v0.0.21
func (x DecorationsRequest_SpanKind) String() string
type DocumentationReply ¶ added in v0.0.21
type DocumentationReply struct { Document []*DocumentationReply_Document `protobuf:"bytes,1,rep,name=document" json:"document,omitempty"` // The facts left from the requested filters of the documented node facts. Nodes map[string]*NodeInfo `` /* 137-byte string literal not displayed */ // Map from the definition tickets referred to in each NodeInfo to their // Anchor. DefinitionLocations map[string]*Anchor `` /* 192-byte string literal not displayed */ }
func (*DocumentationReply) Descriptor ¶ added in v0.0.21
func (*DocumentationReply) Descriptor() ([]byte, []int)
func (*DocumentationReply) GetDefinitionLocations ¶ added in v0.0.25
func (m *DocumentationReply) GetDefinitionLocations() map[string]*Anchor
func (*DocumentationReply) GetDocument ¶ added in v0.0.21
func (m *DocumentationReply) GetDocument() []*DocumentationReply_Document
func (*DocumentationReply) GetNodes ¶ added in v0.0.25
func (m *DocumentationReply) GetNodes() map[string]*NodeInfo
func (*DocumentationReply) Marshal ¶ added in v0.0.21
func (m *DocumentationReply) Marshal() (data []byte, err error)
func (*DocumentationReply) MarshalTo ¶ added in v0.0.21
func (m *DocumentationReply) MarshalTo(data []byte) (int, error)
func (*DocumentationReply) ProtoMessage ¶ added in v0.0.21
func (*DocumentationReply) ProtoMessage()
func (*DocumentationReply) Reset ¶ added in v0.0.21
func (m *DocumentationReply) Reset()
func (*DocumentationReply) Size ¶ added in v0.0.21
func (m *DocumentationReply) Size() (n int)
func (*DocumentationReply) String ¶ added in v0.0.21
func (m *DocumentationReply) String() string
func (*DocumentationReply) Unmarshal ¶ added in v0.0.21
func (m *DocumentationReply) Unmarshal(data []byte) error
type DocumentationReply_Document ¶ added in v0.0.21
type DocumentationReply_Document struct { // The ticket to which this Document refers. Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"` // Documentation that can be displayed to the user. Text *Printable `protobuf:"bytes,2,opt,name=text" json:"text,omitempty"` // A signature that can be displayed to the user. For variables, this // may just be the variable name; for functions, this may be some version // of the function prototype. Signature *Printable `protobuf:"bytes,3,opt,name=signature" json:"signature,omitempty"` // The type as a signature that can be displayed to the user. Type *Printable `protobuf:"bytes,4,opt,name=type" json:"type,omitempty"` // The initialization value, if any. Initializer *Printable `protobuf:"bytes,5,opt,name=initializer" json:"initializer,omitempty"` // The semantic parent of this value. DefinedBy *Printable `protobuf:"bytes,6,opt,name=defined_by,json=definedBy" json:"defined_by,omitempty"` }
func (*DocumentationReply_Document) Descriptor ¶ added in v0.0.21
func (*DocumentationReply_Document) Descriptor() ([]byte, []int)
func (*DocumentationReply_Document) GetDefinedBy ¶ added in v0.0.21
func (m *DocumentationReply_Document) GetDefinedBy() *Printable
func (*DocumentationReply_Document) GetInitializer ¶ added in v0.0.21
func (m *DocumentationReply_Document) GetInitializer() *Printable
func (*DocumentationReply_Document) GetSignature ¶ added in v0.0.21
func (m *DocumentationReply_Document) GetSignature() *Printable
func (*DocumentationReply_Document) GetText ¶ added in v0.0.21
func (m *DocumentationReply_Document) GetText() *Printable
func (*DocumentationReply_Document) GetType ¶ added in v0.0.21
func (m *DocumentationReply_Document) GetType() *Printable
func (*DocumentationReply_Document) Marshal ¶ added in v0.0.21
func (m *DocumentationReply_Document) Marshal() (data []byte, err error)
func (*DocumentationReply_Document) MarshalTo ¶ added in v0.0.21
func (m *DocumentationReply_Document) MarshalTo(data []byte) (int, error)
func (*DocumentationReply_Document) ProtoMessage ¶ added in v0.0.21
func (*DocumentationReply_Document) ProtoMessage()
func (*DocumentationReply_Document) Reset ¶ added in v0.0.21
func (m *DocumentationReply_Document) Reset()
func (*DocumentationReply_Document) Size ¶ added in v0.0.21
func (m *DocumentationReply_Document) Size() (n int)
func (*DocumentationReply_Document) String ¶ added in v0.0.21
func (m *DocumentationReply_Document) String() string
func (*DocumentationReply_Document) Unmarshal ¶ added in v0.0.21
func (m *DocumentationReply_Document) Unmarshal(data []byte) error
type DocumentationRequest ¶ added in v0.0.21
type DocumentationRequest struct { // Semantic tickets about which documentation is sought. Ticket []string `protobuf:"bytes,1,rep,name=ticket" json:"ticket,omitempty"` // A collection of filter globs that specify which facts (by name) should be // returned for each node. If filter is empty or unset, no node facts are // returned. The filter applies to ALL documented and linked nodes. // See EdgesRequest for the format of the filter globs. Filter []string `protobuf:"bytes,2,rep,name=filter" json:"filter,omitempty"` }
func (*DocumentationRequest) Descriptor ¶ added in v0.0.21
func (*DocumentationRequest) Descriptor() ([]byte, []int)
func (*DocumentationRequest) Marshal ¶ added in v0.0.21
func (m *DocumentationRequest) Marshal() (data []byte, err error)
func (*DocumentationRequest) MarshalTo ¶ added in v0.0.21
func (m *DocumentationRequest) MarshalTo(data []byte) (int, error)
func (*DocumentationRequest) ProtoMessage ¶ added in v0.0.21
func (*DocumentationRequest) ProtoMessage()
func (*DocumentationRequest) Reset ¶ added in v0.0.21
func (m *DocumentationRequest) Reset()
func (*DocumentationRequest) Size ¶ added in v0.0.21
func (m *DocumentationRequest) Size() (n int)
func (*DocumentationRequest) String ¶ added in v0.0.21
func (m *DocumentationRequest) String() string
func (*DocumentationRequest) Unmarshal ¶ added in v0.0.21
func (m *DocumentationRequest) Unmarshal(data []byte) error
type EdgeSet ¶
type EdgeSet struct { // Each group is a collection of outbound edges from source node sharing a // given kind, the map's keys. In a given EdgeSet, the server will not send // more than one group with the same kind label. Groups map[string]*EdgeSet_Group `` /* 139-byte string literal not displayed */ }
An EdgeSet represents a collection of edges outbound from a single node. The edges are organized into groups, each sharing a common edge kind.
The number of edges represented by an EdgeSet es, denoted len(es), is the sum of the lengths of the repeated edge fields for all the groups in the EdgeSet. This count is used to determine page size in a request.
func (*EdgeSet) Descriptor ¶ added in v0.0.21
func (*EdgeSet) GetGroups ¶ added in v0.0.22
func (m *EdgeSet) GetGroups() map[string]*EdgeSet_Group
func (*EdgeSet) ProtoMessage ¶
func (*EdgeSet) ProtoMessage()
type EdgeSet_Group ¶
type EdgeSet_Group struct {
Edge []*EdgeSet_Group_Edge `protobuf:"bytes,2,rep,name=edge" json:"edge,omitempty"`
}
func (*EdgeSet_Group) Descriptor ¶ added in v0.0.21
func (*EdgeSet_Group) Descriptor() ([]byte, []int)
func (*EdgeSet_Group) GetEdge ¶ added in v0.0.21
func (m *EdgeSet_Group) GetEdge() []*EdgeSet_Group_Edge
func (*EdgeSet_Group) Marshal ¶ added in v0.0.17
func (m *EdgeSet_Group) Marshal() (data []byte, err error)
func (*EdgeSet_Group) MarshalTo ¶ added in v0.0.17
func (m *EdgeSet_Group) MarshalTo(data []byte) (int, error)
func (*EdgeSet_Group) ProtoMessage ¶
func (*EdgeSet_Group) ProtoMessage()
func (*EdgeSet_Group) Reset ¶
func (m *EdgeSet_Group) Reset()
func (*EdgeSet_Group) Size ¶ added in v0.0.17
func (m *EdgeSet_Group) Size() (n int)
func (*EdgeSet_Group) String ¶
func (m *EdgeSet_Group) String() string
func (*EdgeSet_Group) Unmarshal ¶ added in v0.0.17
func (m *EdgeSet_Group) Unmarshal(data []byte) error
type EdgeSet_Group_Edge ¶ added in v0.0.21
type EdgeSet_Group_Edge struct { TargetTicket string `protobuf:"bytes,1,opt,name=target_ticket,json=targetTicket,proto3" json:"target_ticket,omitempty"` // An optional integer to give an ordering between multiple edges of same // source and kind to one or more targets. See https://kythe.io/schema // for when ordinals are used for a given edge kind. Ordinal int32 `protobuf:"varint,2,opt,name=ordinal,proto3" json:"ordinal,omitempty"` }
func (*EdgeSet_Group_Edge) Descriptor ¶ added in v0.0.21
func (*EdgeSet_Group_Edge) Descriptor() ([]byte, []int)
func (*EdgeSet_Group_Edge) Marshal ¶ added in v0.0.21
func (m *EdgeSet_Group_Edge) Marshal() (data []byte, err error)
func (*EdgeSet_Group_Edge) MarshalTo ¶ added in v0.0.21
func (m *EdgeSet_Group_Edge) MarshalTo(data []byte) (int, error)
func (*EdgeSet_Group_Edge) ProtoMessage ¶ added in v0.0.21
func (*EdgeSet_Group_Edge) ProtoMessage()
func (*EdgeSet_Group_Edge) Reset ¶ added in v0.0.21
func (m *EdgeSet_Group_Edge) Reset()
func (*EdgeSet_Group_Edge) Size ¶ added in v0.0.21
func (m *EdgeSet_Group_Edge) Size() (n int)
func (*EdgeSet_Group_Edge) String ¶ added in v0.0.21
func (m *EdgeSet_Group_Edge) String() string
func (*EdgeSet_Group_Edge) Unmarshal ¶ added in v0.0.21
func (m *EdgeSet_Group_Edge) Unmarshal(data []byte) error
type EdgesReply ¶
type EdgesReply struct { // This field will contain one EdgeSet for each source node with one or more // matching outbound edges, keyed by the source node's ticket. The number of // edges represented by an EdgesReply er, denoted len(er), is the sum of // len(es) for each es in edge_sets. This count is used to determine the page // size. EdgeSets map[string]*EdgeSet `` /* 159-byte string literal not displayed */ // This field will contain one entry, keyed by ticket, for each distinct node // referenced by some edge in edgesets, for which there is one or more // matching facts. // // Rationale: This prevents us from having to copy the data to all the end // nodes, but allows the client to have that information without making // additional requests. Nodes map[string]*NodeInfo `` /* 137-byte string literal not displayed */ // Total number of edges on all pages matching requested kinds, by kind. TotalEdgesByKind map[string]int64 `` /* 195-byte string literal not displayed */ // If there are additional pages of edges after the ones returned in this // reply, next_page_token is the page token that may be passed to fetch the // next page in sequence after this one. If there are no additional edges, // this field will be empty. NextPageToken string `protobuf:"bytes,9,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` }
func (*EdgesReply) Descriptor ¶ added in v0.0.21
func (*EdgesReply) Descriptor() ([]byte, []int)
func (*EdgesReply) GetEdgeSets ¶ added in v0.0.22
func (m *EdgesReply) GetEdgeSets() map[string]*EdgeSet
func (*EdgesReply) GetNodes ¶ added in v0.0.22
func (m *EdgesReply) GetNodes() map[string]*NodeInfo
func (*EdgesReply) GetTotalEdgesByKind ¶ added in v0.0.25
func (m *EdgesReply) GetTotalEdgesByKind() map[string]int64
func (*EdgesReply) Marshal ¶ added in v0.0.17
func (m *EdgesReply) Marshal() (data []byte, err error)
func (*EdgesReply) MarshalTo ¶ added in v0.0.17
func (m *EdgesReply) MarshalTo(data []byte) (int, error)
func (*EdgesReply) ProtoMessage ¶
func (*EdgesReply) ProtoMessage()
func (*EdgesReply) Reset ¶
func (m *EdgesReply) Reset()
func (*EdgesReply) Size ¶ added in v0.0.17
func (m *EdgesReply) Size() (n int)
func (*EdgesReply) String ¶
func (m *EdgesReply) String() string
func (*EdgesReply) Unmarshal ¶ added in v0.0.17
func (m *EdgesReply) Unmarshal(data []byte) error
type EdgesRequest ¶
type EdgesRequest struct { // The tickets of the source nodes for which edges are requested. // The service will return an error if no tickets are specified. Ticket []string `protobuf:"bytes,1,rep,name=ticket" json:"ticket,omitempty"` // The kinds of outbound edges that should be returned for each matching // source node. If empty, all available edge kinds are returned. Kind []string `protobuf:"bytes,2,rep,name=kind" json:"kind,omitempty"` // A collection of filter globs that specify which facts (by name) should be // returned for the target node of each matching edge. If filter is empty, // no facts are returned. // // The supported glob operators are: // * zero or more non-slash characters ([^/]*) // ? any single non-slash character ([^/]) // ** zero or more of any character (.*) // // All other characters match literally, and the glob must consume the entire // name in order to match. The facts returned are the union of those matched // by all the globs provided. Filter []string `protobuf:"bytes,3,rep,name=filter" json:"filter,omitempty"` // The edges matching a request are organized into logical pages. The size // of each page is a number of distinct edges. Notionally: All the matching // edges are ordered lexicographically by (start_ticket, kind, end_ticket); // the page_token determines where in the ordering to start, and page_size // determines how many edges should be returned. // // If page_token is empty, edges will be returned starting at the beginning // of the sequence; otherwise the starting point named by the page_token will // be used. Legal values of page_token are returned by the server in the // next_page_token field of the EdgesReply. A page token should be treated // as an opaque value by the client, and is valid only relative to a // particular set of tickets and kinds. If an invalid page token is // requested, the server will return an error. // // If page_size > 0, at most that number of edges will be returned by the // service for this request (see EdgeSet and EdgesReply below). // If page_size = 0, the default, the server will assume a reasonable default // page size. The server will return an error if page_size < 0. // // The server is allowed to return fewer edges than the requested page_size, // even if more are available, save that it must return at least 1 edge if // any are available at all. PageSize int32 `protobuf:"varint,8,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` PageToken string `protobuf:"bytes,9,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` }
func (*EdgesRequest) Descriptor ¶ added in v0.0.21
func (*EdgesRequest) Descriptor() ([]byte, []int)
func (*EdgesRequest) Marshal ¶ added in v0.0.17
func (m *EdgesRequest) Marshal() (data []byte, err error)
func (*EdgesRequest) MarshalTo ¶ added in v0.0.17
func (m *EdgesRequest) MarshalTo(data []byte) (int, error)
func (*EdgesRequest) ProtoMessage ¶
func (*EdgesRequest) ProtoMessage()
func (*EdgesRequest) Reset ¶
func (m *EdgesRequest) Reset()
func (*EdgesRequest) Size ¶ added in v0.0.17
func (m *EdgesRequest) Size() (n int)
func (*EdgesRequest) String ¶
func (m *EdgesRequest) String() string
func (*EdgesRequest) Unmarshal ¶ added in v0.0.17
func (m *EdgesRequest) Unmarshal(data []byte) error
type Link ¶ added in v0.0.25
type Link struct { // The kind of this span. Kind Link_Kind `protobuf:"varint,2,opt,name=kind,proto3,enum=kythe.proto.Link_Kind" json:"kind,omitempty"` // Semantic tickets for DEFINITION links. Definition []string `protobuf:"bytes,3,rep,name=definition" json:"definition,omitempty"` }
TODO(zarko): Rename to something more appropriate.
func (*Link) Descriptor ¶ added in v0.0.25
func (*Link) ProtoMessage ¶ added in v0.0.25
func (*Link) ProtoMessage()
type Link_Kind ¶ added in v0.0.25
type Link_Kind int32
func (Link_Kind) EnumDescriptor ¶ added in v0.0.25
type Location ¶
type Location struct { // The ticket of the file this location belongs to. If the location // represents a memory buffer, the ticket should be omitted. Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"` // What kind of location this is. Kind Location_Kind `protobuf:"varint,2,opt,name=kind,proto3,enum=kythe.proto.Location_Kind" json:"kind,omitempty"` // The starting point of the location. Start *Location_Point `protobuf:"bytes,3,opt,name=start" json:"start,omitempty"` // The ending point of the location. End *Location_Point `protobuf:"bytes,4,opt,name=end" json:"end,omitempty"` }
A Location represents a single span of zero or more contiguous bytes of a file or buffer. An empty LOCATION denotes the entirety of the referenced file or buffer.
func (*Location) Descriptor ¶ added in v0.0.21
func (*Location) GetEnd ¶
func (m *Location) GetEnd() *Location_Point
func (*Location) GetStart ¶
func (m *Location) GetStart() *Location_Point
func (*Location) ProtoMessage ¶
func (*Location) ProtoMessage()
type Location_Kind ¶
type Location_Kind int32
const ( // The entire file; the start and end fields are ignored. Location_FILE Location_Kind = 0 // The point or span of file subtended by start and end. Location_SPAN Location_Kind = 1 )
func (Location_Kind) EnumDescriptor ¶ added in v0.0.21
func (Location_Kind) EnumDescriptor() ([]byte, []int)
func (Location_Kind) String ¶
func (x Location_Kind) String() string
type Location_Point ¶
type Location_Point struct { // The offset in bytes from the beginning of the file. // Requires 0 ≤ byte_offset ≤ len(file). ByteOffset int32 `protobuf:"varint,1,opt,name=byte_offset,json=byteOffset,proto3" json:"byte_offset,omitempty"` // The line number containing the point, 1-based. LineNumber int32 `protobuf:"varint,2,opt,name=line_number,json=lineNumber,proto3" json:"line_number,omitempty"` // The byte offset of the point within its line. ColumnOffset int32 `protobuf:"varint,3,opt,name=column_offset,json=columnOffset,proto3" json:"column_offset,omitempty"` }
A Point represents a location within a file or buffer.
If line_number ≤ 0, the line number and column offset are considered unknown and will be ignored.
A point with line_number > 0 is said to be _normalized_ if it satisfies the constraint 0 ≤ column_offset ≤ bytelen(line_number); that is, if the column_offset is within the actual range of the corresponding line. A point can be normalized by adjusting line_number and column_offset so that this constraint is satisfied. This may be impossible if the column offset exceeds the bounds of the file.
func (*Location_Point) Descriptor ¶ added in v0.0.21
func (*Location_Point) Descriptor() ([]byte, []int)
func (*Location_Point) Marshal ¶ added in v0.0.17
func (m *Location_Point) Marshal() (data []byte, err error)
func (*Location_Point) MarshalTo ¶ added in v0.0.17
func (m *Location_Point) MarshalTo(data []byte) (int, error)
func (*Location_Point) ProtoMessage ¶
func (*Location_Point) ProtoMessage()
func (*Location_Point) Reset ¶
func (m *Location_Point) Reset()
func (*Location_Point) Size ¶ added in v0.0.17
func (m *Location_Point) Size() (n int)
func (*Location_Point) String ¶
func (m *Location_Point) String() string
func (*Location_Point) Unmarshal ¶ added in v0.0.17
func (m *Location_Point) Unmarshal(data []byte) error
type NodeInfo ¶
type NodeInfo struct { // The matching facts known for that node, a map from fact name to value. Facts map[string][]byte `` /* 144-byte string literal not displayed */ // If known and unambiguous, an anchor ticket for this node's definition // location. Definition string `protobuf:"bytes,5,opt,name=definition,proto3" json:"definition,omitempty"` }
func (*NodeInfo) Descriptor ¶ added in v0.0.21
func (*NodeInfo) ProtoMessage ¶
func (*NodeInfo) ProtoMessage()
type NodesReply ¶
type NodesReply struct { // One NodeInfo, keyed by its ticket, is returned for each requested node // that had a non-zero number of matching facts. Each NodeInfo will not have // its ticket set since it would just be a copy of the map keys. Nodes map[string]*NodeInfo `` /* 137-byte string literal not displayed */ }
func (*NodesReply) Descriptor ¶ added in v0.0.21
func (*NodesReply) Descriptor() ([]byte, []int)
func (*NodesReply) GetNodes ¶ added in v0.0.22
func (m *NodesReply) GetNodes() map[string]*NodeInfo
func (*NodesReply) Marshal ¶ added in v0.0.17
func (m *NodesReply) Marshal() (data []byte, err error)
func (*NodesReply) MarshalTo ¶ added in v0.0.17
func (m *NodesReply) MarshalTo(data []byte) (int, error)
func (*NodesReply) ProtoMessage ¶
func (*NodesReply) ProtoMessage()
func (*NodesReply) Reset ¶
func (m *NodesReply) Reset()
func (*NodesReply) Size ¶ added in v0.0.17
func (m *NodesReply) Size() (n int)
func (*NodesReply) String ¶
func (m *NodesReply) String() string
func (*NodesReply) Unmarshal ¶ added in v0.0.17
func (m *NodesReply) Unmarshal(data []byte) error
type NodesRequest ¶
type NodesRequest struct { // The tickets of the nodes to be looked up. Ticket []string `protobuf:"bytes,1,rep,name=ticket" json:"ticket,omitempty"` // A collection of filter globs that specify which facts (by name) should be // returned for each node. If filter is empty or unset, all available facts // are returned for each matching node. The filter applies to ALL requested // nodes. For different filters per node, the client must issue separate // requests. See EdgesRequest for the format of the filter globs. Filter []string `protobuf:"bytes,2,rep,name=filter" json:"filter,omitempty"` }
func (*NodesRequest) Descriptor ¶ added in v0.0.21
func (*NodesRequest) Descriptor() ([]byte, []int)
func (*NodesRequest) Marshal ¶ added in v0.0.17
func (m *NodesRequest) Marshal() (data []byte, err error)
func (*NodesRequest) MarshalTo ¶ added in v0.0.17
func (m *NodesRequest) MarshalTo(data []byte) (int, error)
func (*NodesRequest) ProtoMessage ¶
func (*NodesRequest) ProtoMessage()
func (*NodesRequest) Reset ¶
func (m *NodesRequest) Reset()
func (*NodesRequest) Size ¶ added in v0.0.17
func (m *NodesRequest) Size() (n int)
func (*NodesRequest) String ¶
func (m *NodesRequest) String() string
func (*NodesRequest) Unmarshal ¶ added in v0.0.17
func (m *NodesRequest) Unmarshal(data []byte) error
type Printable ¶ added in v0.0.25
type Printable struct { // Raw text that can be displayed to the user (but may also contain // markup that can be interpreted, like Doxygen comments). Links are // marked using []. \ is an escape character (where possible escape // sequences are \[, \], and \\). RawText string `protobuf:"bytes,1,opt,name=raw_text,json=rawText,proto3" json:"raw_text,omitempty"` // Annotations for spans in raw_text. The ith Link corresponds to the span // starting at the ith [. Spans may link to definitions; they may also // describe properties of the text (e.g., that parts should not be dropped // when summarizing). Link []*Link `protobuf:"bytes,2,rep,name=link" json:"link,omitempty"` }
func (*Printable) Descriptor ¶ added in v0.0.25
func (*Printable) ProtoMessage ¶ added in v0.0.25
func (*Printable) ProtoMessage()
type XRefServiceClient ¶
type XRefServiceClient interface { // Nodes returns a subset of the facts for each of the requested nodes. Nodes(ctx context.Context, in *NodesRequest, opts ...grpc.CallOption) (*NodesReply, error) // Edges returns a subset of the outbound edges for each of a set of // requested nodes. Edges(ctx context.Context, in *EdgesRequest, opts ...grpc.CallOption) (*EdgesReply, error) // Decorations returns an index of the nodes and edges associated with a // particular file node. Decorations(ctx context.Context, in *DecorationsRequest, opts ...grpc.CallOption) (*DecorationsReply, error) // CrossReferences returns the global references, definitions, and // documentation of a set of requested nodes. CrossReferences(ctx context.Context, in *CrossReferencesRequest, opts ...grpc.CallOption) (*CrossReferencesReply, error) // Documentation takes a set of tickets for semantic objects and returns // documentation about them, including generated signatures and // user-provided text. The documentation may refer to tickets for other // nodes in the graph. Documentation(ctx context.Context, in *DocumentationRequest, opts ...grpc.CallOption) (*DocumentationReply, error) }
func NewXRefServiceClient ¶
func NewXRefServiceClient(cc *grpc.ClientConn) XRefServiceClient
type XRefServiceServer ¶
type XRefServiceServer interface { // Nodes returns a subset of the facts for each of the requested nodes. Nodes(context.Context, *NodesRequest) (*NodesReply, error) // Edges returns a subset of the outbound edges for each of a set of // requested nodes. Edges(context.Context, *EdgesRequest) (*EdgesReply, error) // Decorations returns an index of the nodes and edges associated with a // particular file node. Decorations(context.Context, *DecorationsRequest) (*DecorationsReply, error) // CrossReferences returns the global references, definitions, and // documentation of a set of requested nodes. CrossReferences(context.Context, *CrossReferencesRequest) (*CrossReferencesReply, error) // Documentation takes a set of tickets for semantic objects and returns // documentation about them, including generated signatures and // user-provided text. The documentation may refer to tickets for other // nodes in the graph. Documentation(context.Context, *DocumentationRequest) (*DocumentationReply, error) }