schema

Documentation

Overview

Package schema defines constants used in the Kythe schema.

Index

• Constants
• 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.

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.