kythe

Documentation

Overview

Package kythe implements the kcd.Unit interface for Kythe compilations.

Index

• Constants
• func ConvertUnit(v any) (kcd.Unit, bool)
• type Unit
  • func (u Unit) Canonicalize()
  • func (u Unit) Digest() string
  • func (u Unit) Index() kcd.Index
  • func (u Unit) LookupVName(inputPath string) *spb.VName
  • func (u Unit) MarshalBinary() ([]byte, error)
  • func (u Unit) MarshalJSON() ([]byte, error)

Constants

const Format = "kythe"

Format is the format key used to denote Kythe compilations, stored as kythe.proto.CompilationUnit messages.

Functions

func ConvertUnit

func ConvertUnit(v any) (kcd.Unit, bool)

ConvertUnit reports whether v can be converted to a Kythe kcd.Unit, and if so returns the appropriate implementation.

Types

type Unit

type Unit struct{ Proto *apb.CompilationUnit }

Unit implements the kcd.Unit interface for Kythe compilations.

func (Unit) Canonicalize

func (u Unit) Canonicalize()

Canonicalize satisfies part of the kcd.Unit interface. It orders required inputs by the digest of their contents, orders environment variables and source paths by name, and orders compilation details by their type URL.

func (Unit) Digest

func (u Unit) Digest() string

Digest satisfies part of the kcd.Unit interface.

func (Unit) Index

func (u Unit) Index() kcd.Index

Index satisfies part of the kcd.Unit interface.

func (Unit) LookupVName

func (u Unit) LookupVName(inputPath string) *spb.VName

LookupVName satisfies part of the kcd.Unit interface.

func (Unit) MarshalBinary

func (u Unit) MarshalBinary() ([]byte, error)

MarshalBinary satisfies the encoding.BinaryMarshaler interface.

func (Unit) MarshalJSON

func (u Unit) MarshalJSON() ([]byte, error)

MarshalJSON satisfies the json.Marshaler interface.