Documentation
¶
Overview ¶
Package serving_proto is a generated protocol buffer package.
It is generated from these files:
kythe/proto/serving.proto
It has these top-level messages:
Node Edge EdgeGroup PagedEdgeSet PageIndex EdgePage FileDirectory CorpusRoots File RawAnchor ExpandedAnchor FileDecorations CrossReference PagedCrossReferences PageToken
Index ¶
- Variables
- type CorpusRoots
- func (m *CorpusRoots) GetCorpus() []*CorpusRoots_Corpus
- func (m *CorpusRoots) Marshal() (data []byte, err error)
- func (m *CorpusRoots) MarshalTo(data []byte) (int, error)
- func (*CorpusRoots) ProtoMessage()
- func (m *CorpusRoots) Reset()
- func (m *CorpusRoots) Size() (n int)
- func (m *CorpusRoots) String() string
- func (m *CorpusRoots) Unmarshal(data []byte) error
- type CorpusRoots_Corpus
- func (m *CorpusRoots_Corpus) Marshal() (data []byte, err error)
- func (m *CorpusRoots_Corpus) MarshalTo(data []byte) (int, error)
- func (*CorpusRoots_Corpus) ProtoMessage()
- func (m *CorpusRoots_Corpus) Reset()
- func (m *CorpusRoots_Corpus) Size() (n int)
- func (m *CorpusRoots_Corpus) String() string
- func (m *CorpusRoots_Corpus) Unmarshal(data []byte) error
- type CrossReference
- func (m *CrossReference) GetReferent() *Node
- func (m *CrossReference) GetSourceAnchor() *ExpandedAnchor
- func (m *CrossReference) GetSourceDecoration() *CrossReference_Decoration
- func (m *CrossReference) GetTargetAnchor() *ExpandedAnchor
- func (m *CrossReference) GetTargetDecoration() *CrossReference_Decoration
- func (m *CrossReference) Marshal() (data []byte, err error)
- func (m *CrossReference) MarshalTo(data []byte) (int, error)
- func (*CrossReference) ProtoMessage()
- func (m *CrossReference) Reset()
- func (m *CrossReference) Size() (n int)
- func (m *CrossReference) String() string
- func (m *CrossReference) Unmarshal(data []byte) error
- type CrossReference_Decoration
- func (m *CrossReference_Decoration) GetAnchor() *RawAnchor
- func (m *CrossReference_Decoration) GetFile() *File
- func (m *CrossReference_Decoration) Marshal() (data []byte, err error)
- func (m *CrossReference_Decoration) MarshalTo(data []byte) (int, error)
- func (*CrossReference_Decoration) ProtoMessage()
- func (m *CrossReference_Decoration) Reset()
- func (m *CrossReference_Decoration) Size() (n int)
- func (m *CrossReference_Decoration) String() string
- func (m *CrossReference_Decoration) Unmarshal(data []byte) error
- type Edge
- func (m *Edge) GetFact() []*kythe_proto_common.Fact
- func (m *Edge) GetSource() *Node
- func (m *Edge) GetTarget() *Node
- func (m *Edge) Marshal() (data []byte, err error)
- func (m *Edge) MarshalTo(data []byte) (int, error)
- func (*Edge) ProtoMessage()
- func (m *Edge) Reset()
- func (m *Edge) Size() (n int)
- func (m *Edge) String() string
- func (m *Edge) Unmarshal(data []byte) error
- type EdgeGroup
- func (m *EdgeGroup) GetTarget() []*Node
- func (m *EdgeGroup) Marshal() (data []byte, err error)
- func (m *EdgeGroup) MarshalTo(data []byte) (int, error)
- func (*EdgeGroup) ProtoMessage()
- func (m *EdgeGroup) Reset()
- func (m *EdgeGroup) Size() (n int)
- func (m *EdgeGroup) String() string
- func (m *EdgeGroup) Unmarshal(data []byte) error
- type EdgePage
- func (m *EdgePage) GetEdgesGroup() *EdgeGroup
- func (m *EdgePage) Marshal() (data []byte, err error)
- func (m *EdgePage) MarshalTo(data []byte) (int, error)
- func (*EdgePage) ProtoMessage()
- func (m *EdgePage) Reset()
- func (m *EdgePage) Size() (n int)
- func (m *EdgePage) String() string
- func (m *EdgePage) Unmarshal(data []byte) error
- type ExpandedAnchor
- func (m *ExpandedAnchor) GetSnippetSpan() *kythe_proto_common.Span
- func (m *ExpandedAnchor) GetSpan() *kythe_proto_common.Span
- func (m *ExpandedAnchor) Marshal() (data []byte, err error)
- func (m *ExpandedAnchor) MarshalTo(data []byte) (int, error)
- func (*ExpandedAnchor) ProtoMessage()
- func (m *ExpandedAnchor) Reset()
- func (m *ExpandedAnchor) Size() (n int)
- func (m *ExpandedAnchor) String() string
- func (m *ExpandedAnchor) Unmarshal(data []byte) error
- type File
- type FileDecorations
- func (m *FileDecorations) GetDecoration() []*FileDecorations_Decoration
- func (m *FileDecorations) GetFile() *File
- func (m *FileDecorations) Marshal() (data []byte, err error)
- func (m *FileDecorations) MarshalTo(data []byte) (int, error)
- func (*FileDecorations) ProtoMessage()
- func (m *FileDecorations) Reset()
- func (m *FileDecorations) Size() (n int)
- func (m *FileDecorations) String() string
- func (m *FileDecorations) Unmarshal(data []byte) error
- type FileDecorations_Decoration
- func (m *FileDecorations_Decoration) GetAnchor() *RawAnchor
- func (m *FileDecorations_Decoration) GetTarget() *Node
- func (m *FileDecorations_Decoration) Marshal() (data []byte, err error)
- func (m *FileDecorations_Decoration) MarshalTo(data []byte) (int, error)
- func (*FileDecorations_Decoration) ProtoMessage()
- func (m *FileDecorations_Decoration) Reset()
- func (m *FileDecorations_Decoration) Size() (n int)
- func (m *FileDecorations_Decoration) String() string
- func (m *FileDecorations_Decoration) Unmarshal(data []byte) error
- type FileDirectory
- func (m *FileDirectory) Marshal() (data []byte, err error)
- func (m *FileDirectory) MarshalTo(data []byte) (int, error)
- func (*FileDirectory) ProtoMessage()
- func (m *FileDirectory) Reset()
- func (m *FileDirectory) Size() (n int)
- func (m *FileDirectory) String() string
- func (m *FileDirectory) Unmarshal(data []byte) error
- type Node
- func (m *Node) GetFact() []*kythe_proto_common.Fact
- func (m *Node) Marshal() (data []byte, err error)
- func (m *Node) MarshalTo(data []byte) (int, error)
- func (*Node) ProtoMessage()
- func (m *Node) Reset()
- func (m *Node) Size() (n int)
- func (m *Node) String() string
- func (m *Node) Unmarshal(data []byte) error
- type PageIndex
- type PageToken
- type PagedCrossReferences
- func (m *PagedCrossReferences) GetGroup() []*PagedCrossReferences_Group
- func (m *PagedCrossReferences) GetPageIndex() []*PagedCrossReferences_PageIndex
- func (m *PagedCrossReferences) Marshal() (data []byte, err error)
- func (m *PagedCrossReferences) MarshalTo(data []byte) (int, error)
- func (*PagedCrossReferences) ProtoMessage()
- func (m *PagedCrossReferences) Reset()
- func (m *PagedCrossReferences) Size() (n int)
- func (m *PagedCrossReferences) String() string
- func (m *PagedCrossReferences) Unmarshal(data []byte) error
- type PagedCrossReferences_Group
- func (m *PagedCrossReferences_Group) GetAnchor() []*ExpandedAnchor
- func (m *PagedCrossReferences_Group) Marshal() (data []byte, err error)
- func (m *PagedCrossReferences_Group) MarshalTo(data []byte) (int, error)
- func (*PagedCrossReferences_Group) ProtoMessage()
- func (m *PagedCrossReferences_Group) Reset()
- func (m *PagedCrossReferences_Group) Size() (n int)
- func (m *PagedCrossReferences_Group) String() string
- func (m *PagedCrossReferences_Group) Unmarshal(data []byte) error
- type PagedCrossReferences_Page
- func (m *PagedCrossReferences_Page) GetGroup() *PagedCrossReferences_Group
- func (m *PagedCrossReferences_Page) Marshal() (data []byte, err error)
- func (m *PagedCrossReferences_Page) MarshalTo(data []byte) (int, error)
- func (*PagedCrossReferences_Page) ProtoMessage()
- func (m *PagedCrossReferences_Page) Reset()
- func (m *PagedCrossReferences_Page) Size() (n int)
- func (m *PagedCrossReferences_Page) String() string
- func (m *PagedCrossReferences_Page) Unmarshal(data []byte) error
- type PagedCrossReferences_PageIndex
- func (m *PagedCrossReferences_PageIndex) Marshal() (data []byte, err error)
- func (m *PagedCrossReferences_PageIndex) MarshalTo(data []byte) (int, error)
- func (*PagedCrossReferences_PageIndex) ProtoMessage()
- func (m *PagedCrossReferences_PageIndex) Reset()
- func (m *PagedCrossReferences_PageIndex) Size() (n int)
- func (m *PagedCrossReferences_PageIndex) String() string
- func (m *PagedCrossReferences_PageIndex) Unmarshal(data []byte) error
- type PagedEdgeSet
- func (m *PagedEdgeSet) GetGroup() []*EdgeGroup
- func (m *PagedEdgeSet) GetPageIndex() []*PageIndex
- func (m *PagedEdgeSet) GetSource() *Node
- func (m *PagedEdgeSet) Marshal() (data []byte, err error)
- func (m *PagedEdgeSet) MarshalTo(data []byte) (int, error)
- func (*PagedEdgeSet) ProtoMessage()
- func (m *PagedEdgeSet) Reset()
- func (m *PagedEdgeSet) Size() (n int)
- func (m *PagedEdgeSet) String() string
- func (m *PagedEdgeSet) Unmarshal(data []byte) error
- type RawAnchor
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidLengthServing = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowServing = fmt.Errorf("proto: integer overflow") )
Functions ¶
This section is empty.
Types ¶
type CorpusRoots ¶
type CorpusRoots struct {
Corpus []*CorpusRoots_Corpus `protobuf:"bytes,1,rep,name=corpus" json:"corpus,omitempty"`
}
CorpusRoots describes all of the known corpus/root pairs that contain file nodes.
func (*CorpusRoots) GetCorpus ¶
func (m *CorpusRoots) GetCorpus() []*CorpusRoots_Corpus
func (*CorpusRoots) Marshal ¶ added in v0.0.17
func (m *CorpusRoots) Marshal() (data []byte, err error)
func (*CorpusRoots) MarshalTo ¶ added in v0.0.17
func (m *CorpusRoots) MarshalTo(data []byte) (int, error)
func (*CorpusRoots) ProtoMessage ¶
func (*CorpusRoots) ProtoMessage()
func (*CorpusRoots) Reset ¶
func (m *CorpusRoots) Reset()
func (*CorpusRoots) Size ¶ added in v0.0.17
func (m *CorpusRoots) Size() (n int)
func (*CorpusRoots) String ¶
func (m *CorpusRoots) String() string
func (*CorpusRoots) Unmarshal ¶ added in v0.0.17
func (m *CorpusRoots) Unmarshal(data []byte) error
type CorpusRoots_Corpus ¶
type CorpusRoots_Corpus struct { Corpus string `protobuf:"bytes,1,opt,name=corpus,proto3" json:"corpus,omitempty"` Root []string `protobuf:"bytes,2,rep,name=root" json:"root,omitempty"` }
func (*CorpusRoots_Corpus) Marshal ¶ added in v0.0.17
func (m *CorpusRoots_Corpus) Marshal() (data []byte, err error)
func (*CorpusRoots_Corpus) MarshalTo ¶ added in v0.0.17
func (m *CorpusRoots_Corpus) MarshalTo(data []byte) (int, error)
func (*CorpusRoots_Corpus) ProtoMessage ¶
func (*CorpusRoots_Corpus) ProtoMessage()
func (*CorpusRoots_Corpus) Reset ¶
func (m *CorpusRoots_Corpus) Reset()
func (*CorpusRoots_Corpus) Size ¶ added in v0.0.17
func (m *CorpusRoots_Corpus) Size() (n int)
func (*CorpusRoots_Corpus) String ¶
func (m *CorpusRoots_Corpus) String() string
func (*CorpusRoots_Corpus) Unmarshal ¶ added in v0.0.17
func (m *CorpusRoots_Corpus) Unmarshal(data []byte) error
type CrossReference ¶ added in v0.0.16
type CrossReference struct { SourceDecoration *CrossReference_Decoration `protobuf:"bytes,1,opt,name=source_decoration" json:"source_decoration,omitempty"` Referent *Node `protobuf:"bytes,2,opt,name=referent" json:"referent,omitempty"` TargetDecoration *CrossReference_Decoration `protobuf:"bytes,3,opt,name=target_decoration" json:"target_decoration,omitempty"` SourceAnchor *ExpandedAnchor `protobuf:"bytes,4,opt,name=source_anchor" json:"source_anchor,omitempty"` TargetAnchor *ExpandedAnchor `protobuf:"bytes,5,opt,name=target_anchor" json:"target_anchor,omitempty"` }
A CrossReference represents a path between two anchors, crossing between a single common node. Abstractly this a (file, anchor, kind, node, kind', anchor', file') tuple where the two (file, anchor, kind) sub-components have been named Decorations.
This structure can be used to represent the intermediary* structures needed to build pre-cached responses to the Decorations and CrossReferences service methods.
* where only a subset of this structure is known at that moment in time
func (*CrossReference) GetReferent ¶ added in v0.0.16
func (m *CrossReference) GetReferent() *Node
func (*CrossReference) GetSourceAnchor ¶ added in v0.0.17
func (m *CrossReference) GetSourceAnchor() *ExpandedAnchor
func (*CrossReference) GetSourceDecoration ¶ added in v0.0.16
func (m *CrossReference) GetSourceDecoration() *CrossReference_Decoration
func (*CrossReference) GetTargetAnchor ¶ added in v0.0.17
func (m *CrossReference) GetTargetAnchor() *ExpandedAnchor
func (*CrossReference) GetTargetDecoration ¶ added in v0.0.16
func (m *CrossReference) GetTargetDecoration() *CrossReference_Decoration
func (*CrossReference) Marshal ¶ added in v0.0.17
func (m *CrossReference) Marshal() (data []byte, err error)
func (*CrossReference) MarshalTo ¶ added in v0.0.17
func (m *CrossReference) MarshalTo(data []byte) (int, error)
func (*CrossReference) ProtoMessage ¶ added in v0.0.16
func (*CrossReference) ProtoMessage()
func (*CrossReference) Reset ¶ added in v0.0.16
func (m *CrossReference) Reset()
func (*CrossReference) Size ¶ added in v0.0.17
func (m *CrossReference) Size() (n int)
func (*CrossReference) String ¶ added in v0.0.16
func (m *CrossReference) String() string
func (*CrossReference) Unmarshal ¶ added in v0.0.17
func (m *CrossReference) Unmarshal(data []byte) error
type CrossReference_Decoration ¶ added in v0.0.16
type CrossReference_Decoration struct { File *File `protobuf:"bytes,1,opt,name=file" json:"file,omitempty"` Anchor *RawAnchor `protobuf:"bytes,2,opt,name=anchor" json:"anchor,omitempty"` Kind string `protobuf:"bytes,3,opt,name=kind,proto3" json:"kind,omitempty"` }
A Decoration is specialized partial edge with an anchor on one end, stored along side its parent file node. The partial edge's other end is stored in the referent field of the parent CrossReference.
func (*CrossReference_Decoration) GetAnchor ¶ added in v0.0.16
func (m *CrossReference_Decoration) GetAnchor() *RawAnchor
func (*CrossReference_Decoration) GetFile ¶ added in v0.0.16
func (m *CrossReference_Decoration) GetFile() *File
func (*CrossReference_Decoration) Marshal ¶ added in v0.0.17
func (m *CrossReference_Decoration) Marshal() (data []byte, err error)
func (*CrossReference_Decoration) MarshalTo ¶ added in v0.0.17
func (m *CrossReference_Decoration) MarshalTo(data []byte) (int, error)
func (*CrossReference_Decoration) ProtoMessage ¶ added in v0.0.16
func (*CrossReference_Decoration) ProtoMessage()
func (*CrossReference_Decoration) Reset ¶ added in v0.0.16
func (m *CrossReference_Decoration) Reset()
func (*CrossReference_Decoration) Size ¶ added in v0.0.17
func (m *CrossReference_Decoration) Size() (n int)
func (*CrossReference_Decoration) String ¶ added in v0.0.16
func (m *CrossReference_Decoration) String() string
func (*CrossReference_Decoration) Unmarshal ¶ added in v0.0.17
func (m *CrossReference_Decoration) Unmarshal(data []byte) error
type Edge ¶ added in v0.0.16
type Edge struct { Source *Node `protobuf:"bytes,1,opt,name=source" json:"source,omitempty"` Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"` Target *Node `protobuf:"bytes,3,opt,name=target" json:"target,omitempty"` Fact []*kythe_proto_common.Fact `protobuf:"bytes,4,rep,name=fact" json:"fact,omitempty"` }
Full representation of a Kythe edge; useful during post-processing.
func (*Edge) GetFact ¶ added in v0.0.16
func (m *Edge) GetFact() []*kythe_proto_common.Fact
func (*Edge) ProtoMessage ¶ added in v0.0.16
func (*Edge) ProtoMessage()
type EdgeGroup ¶ added in v0.0.17
type EdgeGroup struct { Kind string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"` Target []*Node `protobuf:"bytes,2,rep,name=target" json:"target,omitempty"` }
An EdgeGroup represents a set of edges with the same kind and source.
Note: this is a derivative of xref.EdgeSet_Group
func (*EdgeGroup) ProtoMessage ¶ added in v0.0.17
func (*EdgeGroup) ProtoMessage()
type EdgePage ¶
type EdgePage struct { // Corresponding PageIndex key that can be used to lookup this page. PageKey string `protobuf:"bytes,1,opt,name=page_key,proto3" json:"page_key,omitempty"` SourceTicket string `protobuf:"bytes,2,opt,name=source_ticket,proto3" json:"source_ticket,omitempty"` EdgesGroup *EdgeGroup `protobuf:"bytes,3,opt,name=edges_group" json:"edges_group,omitempty"` }
EdgePages are a group of edges for a particular edge kind and source ticket.
func (*EdgePage) GetEdgesGroup ¶
func (*EdgePage) ProtoMessage ¶
func (*EdgePage) ProtoMessage()
type ExpandedAnchor ¶ added in v0.0.17
type ExpandedAnchor struct { Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"` Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"` Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"` Text string `protobuf:"bytes,4,opt,name=text,proto3" json:"text,omitempty"` Span *kythe_proto_common.Span `protobuf:"bytes,5,opt,name=span" json:"span,omitempty"` Snippet string `protobuf:"bytes,6,opt,name=snippet,proto3" json:"snippet,omitempty"` SnippetSpan *kythe_proto_common.Span `protobuf:"bytes,7,opt,name=snippet_span" json:"snippet_span,omitempty"` }
ExpandedAnchors are constructed from an RawAnchor and its associated File. They contain normalized Spans based on their parent file's text as well as the UTF8-encoded text for both the anchor's span and its snippet span.
func (*ExpandedAnchor) GetSnippetSpan ¶ added in v0.0.17
func (m *ExpandedAnchor) GetSnippetSpan() *kythe_proto_common.Span
func (*ExpandedAnchor) GetSpan ¶ added in v0.0.17
func (m *ExpandedAnchor) GetSpan() *kythe_proto_common.Span
func (*ExpandedAnchor) Marshal ¶ added in v0.0.17
func (m *ExpandedAnchor) Marshal() (data []byte, err error)
func (*ExpandedAnchor) MarshalTo ¶ added in v0.0.17
func (m *ExpandedAnchor) MarshalTo(data []byte) (int, error)
func (*ExpandedAnchor) ProtoMessage ¶ added in v0.0.17
func (*ExpandedAnchor) ProtoMessage()
func (*ExpandedAnchor) Reset ¶ added in v0.0.17
func (m *ExpandedAnchor) Reset()
func (*ExpandedAnchor) Size ¶ added in v0.0.17
func (m *ExpandedAnchor) Size() (n int)
func (*ExpandedAnchor) String ¶ added in v0.0.17
func (m *ExpandedAnchor) String() string
func (*ExpandedAnchor) Unmarshal ¶ added in v0.0.17
func (m *ExpandedAnchor) Unmarshal(data []byte) error
type File ¶ added in v0.0.16
type File struct { Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"` Text []byte `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"` Encoding string `protobuf:"bytes,3,opt,name=encoding,proto3" json:"encoding,omitempty"` }
A File is a specialized Node structure for file nodes.
func (*File) ProtoMessage ¶ added in v0.0.16
func (*File) ProtoMessage()
type FileDecorations ¶
type FileDecorations struct { File *File `protobuf:"bytes,1,opt,name=file" json:"file,omitempty"` // The decorations located in the file, sorted by starting offset. Decoration []*FileDecorations_Decoration `protobuf:"bytes,2,rep,name=decoration" json:"decoration,omitempty"` }
FileDecorations stores a file's contents and all contained anchor edges.
func (*FileDecorations) GetDecoration ¶
func (m *FileDecorations) GetDecoration() []*FileDecorations_Decoration
func (*FileDecorations) GetFile ¶ added in v0.0.16
func (m *FileDecorations) GetFile() *File
func (*FileDecorations) Marshal ¶ added in v0.0.17
func (m *FileDecorations) Marshal() (data []byte, err error)
func (*FileDecorations) MarshalTo ¶ added in v0.0.17
func (m *FileDecorations) MarshalTo(data []byte) (int, error)
func (*FileDecorations) ProtoMessage ¶
func (*FileDecorations) ProtoMessage()
func (*FileDecorations) Reset ¶
func (m *FileDecorations) Reset()
func (*FileDecorations) Size ¶ added in v0.0.17
func (m *FileDecorations) Size() (n int)
func (*FileDecorations) String ¶
func (m *FileDecorations) String() string
func (*FileDecorations) Unmarshal ¶ added in v0.0.17
func (m *FileDecorations) Unmarshal(data []byte) error
type FileDecorations_Decoration ¶
type FileDecorations_Decoration struct { Anchor *RawAnchor `protobuf:"bytes,1,opt,name=anchor" json:"anchor,omitempty"` Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"` Target *Node `protobuf:"bytes,3,opt,name=target" json:"target,omitempty"` }
Represents an edge from an anchor contained within the file to some target.
func (*FileDecorations_Decoration) GetAnchor ¶
func (m *FileDecorations_Decoration) GetAnchor() *RawAnchor
func (*FileDecorations_Decoration) GetTarget ¶ added in v0.0.16
func (m *FileDecorations_Decoration) GetTarget() *Node
func (*FileDecorations_Decoration) Marshal ¶ added in v0.0.17
func (m *FileDecorations_Decoration) Marshal() (data []byte, err error)
func (*FileDecorations_Decoration) MarshalTo ¶ added in v0.0.17
func (m *FileDecorations_Decoration) MarshalTo(data []byte) (int, error)
func (*FileDecorations_Decoration) ProtoMessage ¶
func (*FileDecorations_Decoration) ProtoMessage()
func (*FileDecorations_Decoration) Reset ¶
func (m *FileDecorations_Decoration) Reset()
func (*FileDecorations_Decoration) Size ¶ added in v0.0.17
func (m *FileDecorations_Decoration) Size() (n int)
func (*FileDecorations_Decoration) String ¶
func (m *FileDecorations_Decoration) String() string
func (*FileDecorations_Decoration) Unmarshal ¶ added in v0.0.17
func (m *FileDecorations_Decoration) Unmarshal(data []byte) error
type FileDirectory ¶
type FileDirectory struct { // Set of URIs for each contained sub-directory's corpus, root, and full path. Subdirectory []string `protobuf:"bytes,1,rep,name=subdirectory" json:"subdirectory,omitempty"` // Set of file node tickets contained within this directory. FileTicket []string `protobuf:"bytes,2,rep,name=file_ticket" json:"file_ticket,omitempty"` }
FileDirectory describes a virtual directory of file nodes.
func (*FileDirectory) Marshal ¶ added in v0.0.17
func (m *FileDirectory) Marshal() (data []byte, err error)
func (*FileDirectory) MarshalTo ¶ added in v0.0.17
func (m *FileDirectory) MarshalTo(data []byte) (int, error)
func (*FileDirectory) ProtoMessage ¶
func (*FileDirectory) ProtoMessage()
func (*FileDirectory) Reset ¶
func (m *FileDirectory) Reset()
func (*FileDirectory) Size ¶ added in v0.0.17
func (m *FileDirectory) Size() (n int)
func (*FileDirectory) String ¶
func (m *FileDirectory) String() string
func (*FileDirectory) Unmarshal ¶ added in v0.0.17
func (m *FileDirectory) Unmarshal(data []byte) error
type Node ¶
type Node struct { Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"` Fact []*kythe_proto_common.Fact `protobuf:"bytes,2,rep,name=fact" json:"fact,omitempty"` }
A derivative of xref.NodeInfo for serving.
func (*Node) GetFact ¶
func (m *Node) GetFact() []*kythe_proto_common.Fact
func (*Node) ProtoMessage ¶
func (*Node) ProtoMessage()
type PageIndex ¶
type PageIndex struct { // The kind of all edges on the referred EdgePage. EdgeKind string `protobuf:"bytes,1,opt,name=edge_kind,proto3" json:"edge_kind,omitempty"` // Total number of edges on the referred EdgePage. EdgeCount int32 `protobuf:"varint,2,opt,name=edge_count,proto3" json:"edge_count,omitempty"` // Key that can be used to lookup the referred EdgePage. PageKey string `protobuf:"bytes,3,opt,name=page_key,proto3" json:"page_key,omitempty"` }
PageIndex is a pointer to an EdgePage. In order to keep the PagedEdgeSet small, we don't store edges here. We just store a key for looking up an EdgePage and the type of edge.
func (*PageIndex) ProtoMessage ¶
func (*PageIndex) ProtoMessage()
type PageToken ¶
type PageToken struct { // Index into the primary reply sequence. Index int32 `protobuf:"varint,1,opt,name=index,proto3" json:"index,omitempty"` // Secondary page token for reply sub-query. SecondaryToken string `protobuf:"bytes,2,opt,name=secondary_token,proto3" json:"secondary_token,omitempty"` }
Internal encoding for an EdgesReply/CrossReferencesReply page_token
func (*PageToken) ProtoMessage ¶
func (*PageToken) ProtoMessage()
type PagedCrossReferences ¶ added in v0.0.17
type PagedCrossReferences struct { SourceTicket string `protobuf:"bytes,1,opt,name=source_ticket,proto3" json:"source_ticket,omitempty"` Group []*PagedCrossReferences_Group `protobuf:"bytes,2,rep,name=group" json:"group,omitempty"` PageIndex []*PagedCrossReferences_PageIndex `protobuf:"bytes,3,rep,name=page_index" json:"page_index,omitempty"` TotalReferences int32 `protobuf:"varint,4,opt,name=total_references,proto3" json:"total_references,omitempty"` }
PagedCrossReferences are used for efficiently storing pre-cached data for CrossReferencesReply.{definition,reference,documentation} anchors. Related nodes can be retrieved from edge sets/pages.
func (*PagedCrossReferences) GetGroup ¶ added in v0.0.17
func (m *PagedCrossReferences) GetGroup() []*PagedCrossReferences_Group
func (*PagedCrossReferences) GetPageIndex ¶ added in v0.0.17
func (m *PagedCrossReferences) GetPageIndex() []*PagedCrossReferences_PageIndex
func (*PagedCrossReferences) Marshal ¶ added in v0.0.17
func (m *PagedCrossReferences) Marshal() (data []byte, err error)
func (*PagedCrossReferences) MarshalTo ¶ added in v0.0.17
func (m *PagedCrossReferences) MarshalTo(data []byte) (int, error)
func (*PagedCrossReferences) ProtoMessage ¶ added in v0.0.17
func (*PagedCrossReferences) ProtoMessage()
func (*PagedCrossReferences) Reset ¶ added in v0.0.17
func (m *PagedCrossReferences) Reset()
func (*PagedCrossReferences) Size ¶ added in v0.0.17
func (m *PagedCrossReferences) Size() (n int)
func (*PagedCrossReferences) String ¶ added in v0.0.17
func (m *PagedCrossReferences) String() string
func (*PagedCrossReferences) Unmarshal ¶ added in v0.0.17
func (m *PagedCrossReferences) Unmarshal(data []byte) error
type PagedCrossReferences_Group ¶ added in v0.0.17
type PagedCrossReferences_Group struct { Kind string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"` Anchor []*ExpandedAnchor `protobuf:"bytes,2,rep,name=anchor" json:"anchor,omitempty"` }
func (*PagedCrossReferences_Group) GetAnchor ¶ added in v0.0.17
func (m *PagedCrossReferences_Group) GetAnchor() []*ExpandedAnchor
func (*PagedCrossReferences_Group) Marshal ¶ added in v0.0.17
func (m *PagedCrossReferences_Group) Marshal() (data []byte, err error)
func (*PagedCrossReferences_Group) MarshalTo ¶ added in v0.0.17
func (m *PagedCrossReferences_Group) MarshalTo(data []byte) (int, error)
func (*PagedCrossReferences_Group) ProtoMessage ¶ added in v0.0.17
func (*PagedCrossReferences_Group) ProtoMessage()
func (*PagedCrossReferences_Group) Reset ¶ added in v0.0.17
func (m *PagedCrossReferences_Group) Reset()
func (*PagedCrossReferences_Group) Size ¶ added in v0.0.17
func (m *PagedCrossReferences_Group) Size() (n int)
func (*PagedCrossReferences_Group) String ¶ added in v0.0.17
func (m *PagedCrossReferences_Group) String() string
func (*PagedCrossReferences_Group) Unmarshal ¶ added in v0.0.17
func (m *PagedCrossReferences_Group) Unmarshal(data []byte) error
type PagedCrossReferences_Page ¶ added in v0.0.17
type PagedCrossReferences_Page struct { PageKey string `protobuf:"bytes,1,opt,name=page_key,proto3" json:"page_key,omitempty"` SourceTicket string `protobuf:"bytes,2,opt,name=source_ticket,proto3" json:"source_ticket,omitempty"` Group *PagedCrossReferences_Group `protobuf:"bytes,3,opt,name=group" json:"group,omitempty"` }
func (*PagedCrossReferences_Page) GetGroup ¶ added in v0.0.17
func (m *PagedCrossReferences_Page) GetGroup() *PagedCrossReferences_Group
func (*PagedCrossReferences_Page) Marshal ¶ added in v0.0.17
func (m *PagedCrossReferences_Page) Marshal() (data []byte, err error)
func (*PagedCrossReferences_Page) MarshalTo ¶ added in v0.0.17
func (m *PagedCrossReferences_Page) MarshalTo(data []byte) (int, error)
func (*PagedCrossReferences_Page) ProtoMessage ¶ added in v0.0.17
func (*PagedCrossReferences_Page) ProtoMessage()
func (*PagedCrossReferences_Page) Reset ¶ added in v0.0.17
func (m *PagedCrossReferences_Page) Reset()
func (*PagedCrossReferences_Page) Size ¶ added in v0.0.17
func (m *PagedCrossReferences_Page) Size() (n int)
func (*PagedCrossReferences_Page) String ¶ added in v0.0.17
func (m *PagedCrossReferences_Page) String() string
func (*PagedCrossReferences_Page) Unmarshal ¶ added in v0.0.17
func (m *PagedCrossReferences_Page) Unmarshal(data []byte) error
type PagedCrossReferences_PageIndex ¶ added in v0.0.17
type PagedCrossReferences_PageIndex struct { Kind string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"` Count int32 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"` PageKey string `protobuf:"bytes,3,opt,name=page_key,proto3" json:"page_key,omitempty"` }
A PageIndex is a reference to a Page.
func (*PagedCrossReferences_PageIndex) Marshal ¶ added in v0.0.17
func (m *PagedCrossReferences_PageIndex) Marshal() (data []byte, err error)
func (*PagedCrossReferences_PageIndex) MarshalTo ¶ added in v0.0.17
func (m *PagedCrossReferences_PageIndex) MarshalTo(data []byte) (int, error)
func (*PagedCrossReferences_PageIndex) ProtoMessage ¶ added in v0.0.17
func (*PagedCrossReferences_PageIndex) ProtoMessage()
func (*PagedCrossReferences_PageIndex) Reset ¶ added in v0.0.17
func (m *PagedCrossReferences_PageIndex) Reset()
func (*PagedCrossReferences_PageIndex) Size ¶ added in v0.0.17
func (m *PagedCrossReferences_PageIndex) Size() (n int)
func (*PagedCrossReferences_PageIndex) String ¶ added in v0.0.17
func (m *PagedCrossReferences_PageIndex) String() string
func (*PagedCrossReferences_PageIndex) Unmarshal ¶ added in v0.0.17
func (m *PagedCrossReferences_PageIndex) Unmarshal(data []byte) error
type PagedEdgeSet ¶
type PagedEdgeSet struct { // The source node for all the edges in the edge set. Source *Node `protobuf:"bytes,1,opt,name=source" json:"source,omitempty"` // Each group is a collection of outbound edges from source node sharing a // given kind. Group []*EdgeGroup `protobuf:"bytes,2,rep,name=group" json:"group,omitempty"` // Total number of edges in all of the EdgePages, including this one. TotalEdges int32 `protobuf:"varint,3,opt,name=total_edges,proto3" json:"total_edges,omitempty"` // Page indices for other EdgePages, sorted by edge kind. PageIndex []*PageIndex `protobuf:"bytes,4,rep,name=page_index" json:"page_index,omitempty"` }
PagedEdgeSets are used for efficiently storing EdgeSets, all originating from the same source ticket, in order to handle pagination requests.
func (*PagedEdgeSet) GetGroup ¶ added in v0.0.17
func (m *PagedEdgeSet) GetGroup() []*EdgeGroup
func (*PagedEdgeSet) GetPageIndex ¶
func (m *PagedEdgeSet) GetPageIndex() []*PageIndex
func (*PagedEdgeSet) GetSource ¶ added in v0.0.17
func (m *PagedEdgeSet) GetSource() *Node
func (*PagedEdgeSet) Marshal ¶ added in v0.0.17
func (m *PagedEdgeSet) Marshal() (data []byte, err error)
func (*PagedEdgeSet) MarshalTo ¶ added in v0.0.17
func (m *PagedEdgeSet) MarshalTo(data []byte) (int, error)
func (*PagedEdgeSet) ProtoMessage ¶
func (*PagedEdgeSet) ProtoMessage()
func (*PagedEdgeSet) Reset ¶
func (m *PagedEdgeSet) Reset()
func (*PagedEdgeSet) Size ¶ added in v0.0.17
func (m *PagedEdgeSet) Size() (n int)
func (*PagedEdgeSet) String ¶
func (m *PagedEdgeSet) String() string
func (*PagedEdgeSet) Unmarshal ¶ added in v0.0.17
func (m *PagedEdgeSet) Unmarshal(data []byte) error
type RawAnchor ¶ added in v0.0.17
type RawAnchor struct { Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"` StartOffset int32 `protobuf:"varint,2,opt,name=start_offset,proto3" json:"start_offset,omitempty"` EndOffset int32 `protobuf:"varint,3,opt,name=end_offset,proto3" json:"end_offset,omitempty"` SnippetStart int32 `protobuf:"varint,4,opt,name=snippet_start,proto3" json:"snippet_start,omitempty"` SnippetEnd int32 `protobuf:"varint,5,opt,name=snippet_end,proto3" json:"snippet_end,omitempty"` }
A RawAnchor is a specialized Node structure for anchor nodes.
func (*RawAnchor) ProtoMessage ¶ added in v0.0.17
func (*RawAnchor) ProtoMessage()