schema

Documentation

Overview

Package schema defines constants used in the Kythe schema.

Index

• Constants
• func EdgeKind(k string) scpb.EdgeKind
• func EdgeKindString(k scpb.EdgeKind) string
• func FactName(f string) scpb.FactName
• func FactNameString(f scpb.FactName) string
• func GetEdgeKind(e *scpb.Edge) string
• func GetFactName(f *scpb.Fact) string
• func GetNodeKind(n *scpb.Node) string
• func GetSubkind(n *scpb.Node) string
• func NodeKind(k string) scpb.NodeKind
• func NodeKindString(k scpb.NodeKind) string
• func Subkind(k string) scpb.Subkind
• func SubkindString(k scpb.Subkind) string
• type Edge
  • func (e *Edge) ToEntry() *spb.Entry
• type Facts
• type Node
  • func (n *Node) AddFact(name, value string)
  • func (n *Node) ToEntries() []*spb.Entry

Constants

const (
	// AnchorLocFilter is a fact filter for anchor locations.
	AnchorLocFilter = "/kythe/loc/*"

	// SnippetLocFilter is a fact filter for snippet locations.
	SnippetLocFilter = "/kythe/snippet/*"
)

const Prefix = "/kythe/"

Prefix is the label prefix for the Kythe schema.

Functions

func EdgeKind

func EdgeKind(k string) scpb.EdgeKind

EdgeKind returns the schema enum for the given edge kind.

func EdgeKindString

func EdgeKindString(k scpb.EdgeKind) string

EdgeKindString returns the string representation of the given edge kind.

func FactName

func FactName(f string) scpb.FactName

FactName returns the schema enum for the given fact name.

func FactNameString

func FactNameString(f scpb.FactName) string

FactNameString returns the string representation of the given fact name.

func GetEdgeKind

func GetEdgeKind(e *scpb.Edge) string

GetEdgeKind returns the string representation of the edge's kind.

func GetFactName

func GetFactName(f *scpb.Fact) string

GetFactName returns the string representation of the fact's name.

func GetNodeKind

func GetNodeKind(n *scpb.Node) string

GetNodeKind returns the string representation of the node's kind.

func GetSubkind

func GetSubkind(n *scpb.Node) string

GetSubkind returns the string representation of the node's subkind.

func NodeKind

func NodeKind(k string) scpb.NodeKind

NodeKind returns the schema enum for the given node kind.

func NodeKindString

func NodeKindString(k scpb.NodeKind) string

NodeKindString returns the string representation of the given node kind.

func Subkind

func Subkind(k string) scpb.Subkind

Subkind returns the schema enum for the given subkind.

func SubkindString

func SubkindString(k scpb.Subkind) string

SubkindString returns the string representation of the given subkind.

Types

type Edge

type Edge struct {
	Source, Target *spb.VName
	Kind           string
}

An Edge represents an edge.

func (*Edge) ToEntry

func (e *Edge) ToEntry() *spb.Entry

ToEntry converts e to a kythe.proto.Entry message.

type Facts

type Facts map[string]string

Facts represents a collection of key/value facts.

type Node

type Node struct {
	VName *spb.VName
	Kind  string
	Facts Facts
}

A Node represents a collection of facts about a node.

func (*Node) AddFact

func (n *Node) AddFact(name, value string)

AddFact adds the specified fact to n, replacing any previous value for that fact that may exist.

func (*Node) ToEntries

func (n *Node) ToEntries() []*spb.Entry

ToEntries converts n to a slice of kythe.proto.Entry messages. The result will have at least one entry for the node kind. If n contains a text fact and does not supply an explicit encoding, the default one is also added. The resulting slice is not ordered.