Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

common

package

Go to main page

Versions in this module

v0

v0.32.0

Aug 19, 2026

v0.30.0

Jul 31, 2026

Changes in this version

+ func MultilineDescription(lines ...string) string

+ func ParseDescription(doc string) string

+ func ParseDescriptions(doc string) []string

+ type Doc struct

+ Children []*Doc

+ Description string

+ Kind DocKind

+ Name string

+ Signature string

+ Type string

+ func NewExampleDoc(ex string) *Doc

+ func NewFieldDoc(name, celType, description string, examples ...*Doc) *Doc

+ func NewFunctionDoc(name, description string, overloads ...*Doc) *Doc

+ func NewMacroDoc(name, description string, examples ...*Doc) *Doc

+ func NewOverloadDoc(id, signature string, examples ...*Doc) *Doc

+ func NewVariableDoc(name, celType, description string) *Doc

+ type DocKind int

+ const DocEnv

+ const DocExample

+ const DocField

+ const DocFunction

+ const DocMacro

+ const DocOverload

+ const DocVariable

+ type Documentor interface

+ Documentation func() *Doc

type Errors

+ func (e *Errors) ReportErrorString(l Location, message string)

type Source

+ func NewStringSourceWithLimit(contents string, description string, limit int) (Source, error)

+ func NewTextSourceWithLimit(text string, limit int) (Source, error)

v0.20.2

May 2, 2024

v0.17.5

Aug 21, 2023

v0.17.4

Aug 21, 2023

v0.17.3

Aug 21, 2023

Changes in this version

+ const ConstCost

+ const ListCreateBaseCost

+ const MapCreateBaseCost

+ const RegexStringLengthCostFactor

+ const SelectAndIdentCost

+ const StringTraversalCostFactor

+ const StructCreateBaseCost

type Error

+ ExprID int64

+ func NewError(id int64, message string, location Location) *Error

type Errors

+ func (e *Errors) Append(errs []*Error) *Errors

+ func (e *Errors) ReportErrorAtID(id int64, l Location, format string, args ...any)

type Source

+ NewLocation func(line, col int) Location

v0.1.0

Feb 5, 2019

Changes in this version

+ var NoLocation = &SourceLocation

+ type Error struct

+ Location Location

+ Message string

+ func (e *Error) ToDisplayString(source Source) string

+ type Errors struct

+ func NewErrors(source Source) *Errors

+ func (e *Errors) GetErrors() []Error

+ func (e *Errors) ReportError(l Location, format string, args ...interface{})

+ func (e *Errors) ToDisplayString() string

+ type Location interface

+ Column func() int

+ Line func() int

+ func NewLocation(line, column int) Location

+ type Source interface

+ Content func() string

+ Description func() string

+ IDLocation func(exprID int64) (Location, bool)

+ IDOffset func(exprID int64) (int32, bool)

+ LineOffsets func() []int32

+ LocationOffset func(location Location) (int32, bool)

+ OffsetLocation func(offset int32) (Location, bool)

+ Snippet func(line int) (string, bool)

+ func NewInfoSource(info *exprpb.SourceInfo) Source

+ func NewStringSource(contents string, description string) Source

+ func NewTextSource(text string) Source

+ type SourceLocation struct

+ func (l *SourceLocation) Column() int

+ func (l *SourceLocation) Line() int