columnar

Documentation

Overview

Package columnar implements the columnar table format for a Kythe xrefs service.

Index

• Variables
• func DecodeCrossReferencesEntry(src *spb.VName, key string, val []byte) (*xspb.CrossReferences, error)
• func DecodeDecorationsEntry(file *spb.VName, key string, val []byte) (*xspb.FileDecorations, error)
• type KV
  • func EncodeCrossReferencesEntry(keyPrefix []byte, xr *xspb.CrossReferences) (*KV, error)
  • func EncodeDecorationsEntry(keyPrefix []byte, fd *xspb.FileDecorations) (*KV, error)

Variables

var (
	// DecorationsKeyPrefix is the common key prefix for all Kythe columnar
	// FileDecoration key-value entries.
	DecorationsKeyPrefix, _ = keys.Append(nil, "fd")

	// CrossReferencesKeyPrefix is the common key prefix for all Kythe columnar
	// CrossReferences key-value entries.
	CrossReferencesKeyPrefix, _ = keys.Append(nil, "xr")
)

Functions

func DecodeCrossReferencesEntry

func DecodeCrossReferencesEntry(src *spb.VName, key string, val []byte) (*xspb.CrossReferences, error)

DecodeCrossReferencesEntry decodes a columnar CrossReferences entry.

func DecodeDecorationsEntry

func DecodeDecorationsEntry(file *spb.VName, key string, val []byte) (*xspb.FileDecorations, error)

DecodeDecorationsEntry decodes a columnar FileDecorations entry.

Types

type KV

type KV struct{ Key, Value []byte }

KV is a single columnar key-value entry.

func EncodeCrossReferencesEntry

func EncodeCrossReferencesEntry(keyPrefix []byte, xr *xspb.CrossReferences) (*KV, error)

EncodeCrossReferencesEntry encodes a columnar CrossReferences entry.

func EncodeDecorationsEntry

func EncodeDecorationsEntry(keyPrefix []byte, fd *xspb.FileDecorations) (*KV, error)

EncodeDecorationsEntry encodes a columnar FileDecorations entry.