Back to godoc.org

Package protosource

v0.28.0
Latest Go to latest

The latest major version is .

Published: 2 days ago | License: Apache-2.0 | Module: github.com/bufbuild/buf

Overview

Package protosource defines minimal interfaces for Protobuf descriptor types.

This is done so that the backing package can be swapped out easily.

All values that return SourceLocation can be nil.

Testing is currently implicitly done through the bufcheck packages, however if this were to be split out into a separate library, it would need a separate testing suite.

Index

Constants

const (
	// FieldDescriptorProtoTypeDouble is an alias.
	FieldDescriptorProtoTypeDouble FieldDescriptorProtoType = 1
	// FieldDescriptorProtoTypeFloat is an alias.
	FieldDescriptorProtoTypeFloat FieldDescriptorProtoType = 2
	// FieldDescriptorProtoTypeInt64 is an alias.
	FieldDescriptorProtoTypeInt64 FieldDescriptorProtoType = 3
	// FieldDescriptorProtoTypeUint64 is an alias.
	FieldDescriptorProtoTypeUint64 FieldDescriptorProtoType = 4
	// FieldDescriptorProtoTypeInt32 is an alias.
	FieldDescriptorProtoTypeInt32 FieldDescriptorProtoType = 5
	// FieldDescriptorProtoTypeFixed64 is an alias.
	FieldDescriptorProtoTypeFixed64 FieldDescriptorProtoType = 6
	// FieldDescriptorProtoTypeFixed32 is an alias.
	FieldDescriptorProtoTypeFixed32 FieldDescriptorProtoType = 7
	// FieldDescriptorProtoTypeBool is an alias.
	FieldDescriptorProtoTypeBool FieldDescriptorProtoType = 8
	// FieldDescriptorProtoTypeString is an alias.
	FieldDescriptorProtoTypeString FieldDescriptorProtoType = 9
	// FieldDescriptorProtoTypeGroup is an alias.
	FieldDescriptorProtoTypeGroup FieldDescriptorProtoType = 10
	// FieldDescriptorProtoTypeMessage is an alias.
	FieldDescriptorProtoTypeMessage FieldDescriptorProtoType = 11
	// FieldDescriptorProtoTypeBytes is an alias.
	FieldDescriptorProtoTypeBytes FieldDescriptorProtoType = 12
	// FieldDescriptorProtoTypeUint32 is an alias.
	FieldDescriptorProtoTypeUint32 FieldDescriptorProtoType = 13
	// FieldDescriptorProtoTypeEnum is an alias.
	FieldDescriptorProtoTypeEnum FieldDescriptorProtoType = 14
	// FieldDescriptorProtoTypeSfixed32 is an alias.
	FieldDescriptorProtoTypeSfixed32 FieldDescriptorProtoType = 15
	// FieldDescriptorProtoTypeSfixed64 is an alias.
	FieldDescriptorProtoTypeSfixed64 FieldDescriptorProtoType = 16
	// FieldDescriptorProtoTypeSint32 is an alias.
	FieldDescriptorProtoTypeSint32 FieldDescriptorProtoType = 17
	// FieldDescriptorProtoTypeSint64 is an alias.
	FieldDescriptorProtoTypeSint64 FieldDescriptorProtoType = 18

	// FieldDescriptorProtoLabelOptional is an alias.
	FieldDescriptorProtoLabelOptional FieldDescriptorProtoLabel = 1
	// FieldDescriptorProtoLabelRequired is an alias.
	FieldDescriptorProtoLabelRequired FieldDescriptorProtoLabel = 2
	// FieldDescriptorProtoLabelRepeated is an alias.
	FieldDescriptorProtoLabelRepeated FieldDescriptorProtoLabel = 3

	// FieldOptionsCTypeString is an alias.
	FieldOptionsCTypeString FieldOptionsCType = 0
	// FieldOptionsCTypeCord is an alias.
	FieldOptionsCTypeCord FieldOptionsCType = 1
	// FieldOptionsCTypeStringPiece is an alias.
	FieldOptionsCTypeStringPiece FieldOptionsCType = 2

	// FieldOptionsJSTypeJSNormal is an alias.
	FieldOptionsJSTypeJSNormal FieldOptionsJSType = 0
	// FieldOptionsJSTypeJSString is an alias.
	FieldOptionsJSTypeJSString FieldOptionsJSType = 1
	// FieldOptionsJSTypeJSNumber is an alias.
	FieldOptionsJSTypeJSNumber FieldOptionsJSType = 2

	// FileOptionsOptimizeModeSpeed is an alias.
	FileOptionsOptimizeModeSpeed FileOptionsOptimizeMode = 1
	// FileOptionsOptimizeModeCodeSize is an alias.
	FileOptionsOptimizeModeCodeSize FileOptionsOptimizeMode = 2
	// FileOptionsOptimizeModeLiteRuntime is an alias.
	FileOptionsOptimizeModeLiteRuntime FileOptionsOptimizeMode = 3

	// MethodOptionsIdempotencyLevelIdempotencyUnknown is an alias.
	MethodOptionsIdempotencyLevelIdempotencyUnknown = 0
	// MethodOptionsIdempotencyLevelNoSideEffects is an alias.
	MethodOptionsIdempotencyLevelNoSideEffects = 1
	// MethodOptionsIdempotencyLevelIdempotent is an alias.
	MethodOptionsIdempotencyLevelIdempotent = 2
)

func DirPathToFiles

func DirPathToFiles(files ...File) (map[string][]File, error)

DirPathToFiles maps the Files to a map from directory to the slice of Files in that directory.

Returns error if file paths are not unique. Directories are normalized.

Files will be sorted by FilePath.

func FilePathToFile

func FilePathToFile(files ...File) (map[string]File, error)

FilePathToFile maps the Files to a map from Path() to File.

Returns error if file paths are not unique.

func ForEachEnum

func ForEachEnum(f func(Enum) error, containerDescriptor ContainerDescriptor) error

ForEachEnum calls f on each Enum in the given ContainerDescriptor, including nested Enums.

Returns error and stops iterating if f returns error Never returns error unless f returns error.

func ForEachMessage

func ForEachMessage(f func(Message) error, containerDescriptor ContainerDescriptor) error

ForEachMessage calls f on each Message in the given ContainerDescriptor, including nested Messages.

Returns error and stops iterating if f returns error Never returns error unless f returns error.

func FreeMessageRangeString

func FreeMessageRangeString(message Message) string

FreeMessageRangeString returns the string representation of the free ranges for the message.

func FullNameToEnum

func FullNameToEnum(files ...File) (map[string]Enum, error)

FullNameToEnum maps the Enums in the Files to a map from full name to enum.

Returns error if the Enums do not have unique full names within the Files, which should generally never happen for properly-formed Files.

func FullNameToMessage

func FullNameToMessage(files ...File) (map[string]Message, error)

FullNameToMessage maps the Messages in the Files to a map from full name to message.

Returns error if the Messages do not have unique full names within the Files, which should generally never happen for properly-formed Files.

func FullNameToMethod

func FullNameToMethod(files ...File) (map[string]Method, error)

FullNameToMethod maps the Methods in the Files to a map from full name to Method.

Returns error if Methods do not have unique full names within the Files, which should generally never happen for properly-formed Files.

func FullNameToService

func FullNameToService(files ...File) (map[string]Service, error)

FullNameToService maps the Services in the Files to a map from full name to Service.

Returns error if Services do not have unique full names within the Files, which should generally never happen for properly-formed Files.

func NameInReservedNames

func NameInReservedNames(name string, reservedNames ...ReservedName) bool

NameInReservedNames returns true if the name is in one of the ReservedNames.

func NameToEnumValue

func NameToEnumValue(enum Enum) (map[string]EnumValue, error)

NameToEnumValue maps the EnumValues in the Enum to a map from name to EnumValue.

Returns error if the EnumValues do not have unique names within the Enum, which should generally never happen for properly-formed Enums.

func NameToMessageOneof

func NameToMessageOneof(message Message) (map[string]Oneof, error)

NameToMessageOneof maps the Oneofs in the Message to a map from name to Oneof.

Returns error if the Oneofs do not have unique names within the Message, which should generally never happen for properly-formed Messages.

func NameToMethod

func NameToMethod(service Service) (map[string]Method, error)

NameToMethod maps the Methods in the Service to a map from name to Method.

Returns error if Methods do not have unique names within the Service, which should generally never happen for properly-formed Services.

func NameToService

func NameToService(file File) (map[string]Service, error)

NameToService maps the Services in the File to a map from name to Service.

Returns error if Services do not have unique names within the File, which should generally never happen for properly-formed Files.

func NestedNameToEnum

func NestedNameToEnum(containerDescriptor ContainerDescriptor) (map[string]Enum, error)

NestedNameToEnum maps the Enums in the ContainerDescriptor to a map from nested name to Enum.

Returns error if Enums do not have unique nested names within the ContainerDescriptor, which should generally never happen for properly-formed ContainerDescriptors.

func NestedNameToMessage

func NestedNameToMessage(containerDescriptor ContainerDescriptor) (map[string]Message, error)

NestedNameToMessage maps the Messages in the ContainerDescriptor to a map from nested name to Message.

Returns error if Messages do not have unique nested names within the ContainerDescriptor, which should generally never happen for properly-formed files.

func NumberInReservedRanges

func NumberInReservedRanges(number int, reservedRanges ...TagRange) bool

NumberInReservedRanges returns true if the number is in one of the Ranges.

func NumberToMessageField

func NumberToMessageField(message Message) (map[int]Field, error)

NumberToMessageField maps the Fields in the Message to a map from number to Field.

TODO: is this right? Includes extensions.

Returns error if the Fields do not have unique numbers within the Message, which should generally never happen for properly-formed Messages.

func NumberToNameToEnumValue

func NumberToNameToEnumValue(enum Enum) (map[int]map[string]EnumValue, error)

NumberToNameToEnumValue maps the EnumValues in the Enum to a map from number to name to EnumValue.

Duplicates by number may occur if allow_alias = true.

Returns error if the EnumValues do not have unique names within the Enum for a given number, which should generally never happen for properly-formed Enums.

func PackageToFiles

func PackageToFiles(files ...File) (map[string][]File, error)

PackageToFiles maps the Files to a map from Protobuf package to the slice of Files in that package.

Returns error if file paths are not unique.

Files will be sorted by Path.

func PackageToNameToService

func PackageToNameToService(files ...File) (map[string]map[string]Service, error)

PackageToNameToService maps the Services in the Files to a map from package to name to Service.

Returns error if the Services do not have unique names within the packages, which should generally never happen for properly-formed Files.

func PackageToNestedNameToEnum

func PackageToNestedNameToEnum(files ...File) (map[string]map[string]Enum, error)

PackageToNestedNameToEnum maps the Enums in the Files to a map from package to nested name to Enum.

Returns error if the Enums do not have unique nested names within the packages, which should generally never happen for properly-formed Files.

func PackageToNestedNameToMessage

func PackageToNestedNameToMessage(files ...File) (map[string]map[string]Message, error)

PackageToNestedNameToMessage maps the Messages in the Files to a map from package to nested name to Message.

Returns error if the Messages do not have unique nested names within the packages, which should generally never happen for properly-formed Files.

func SortFiles

func SortFiles(files []File)

SortFiles sorts the Files by FilePath.

func StringToExtensionMessageRange

func StringToExtensionMessageRange(message Message) map[string]MessageRange

StringToExtensionMessageRange maps the ExtensionMessageRanges in the Message to a map from string string to ExtensionMessageRange.

Ignores duplicates.

func StringToReservedTagRange

func StringToReservedTagRange(reservedDescriptor ReservedDescriptor) map[string]TagRange

StringToReservedTagRange maps the ReservedTagRanges in the ReservedDescriptor to a map from string string to reserved TagRange.

Ignores duplicates.

func TagRangeString

func TagRangeString(tagRange TagRange) string

TagRangeString returns the string representation of the range.

func ValueToReservedName

func ValueToReservedName(reservedDescriptor ReservedDescriptor) map[string]ReservedName

ValueToReservedName maps the ReservedNames in the ReservedDescriptor to a map from string value to ReservedName.

Ignores duplicates.

type ContainerDescriptor

type ContainerDescriptor interface {
	Enums() []Enum
	Messages() []Message
}

ContainerDescriptor contains Enums and Messages.

type Descriptor

type Descriptor interface {
	// File returns the associated File.
	//
	// Always non-nil.
	File() File
}

Descriptor is the base interface for a descriptor type.

type Enum

type Enum interface {
	NamedDescriptor
	ReservedDescriptor

	Values() []EnumValue
	ReservedEnumRanges() []EnumRange

	AllowAlias() bool
	AllowAliasLocation() Location
}

Enum is an enum descriptor.

type EnumRange

type EnumRange interface {
	TagRange

	Enum() Enum
}

EnumRange is a TagRange for Enums.

type EnumValue

type EnumValue interface {
	NamedDescriptor

	Enum() Enum
	Number() int

	NumberLocation() Location
}

EnumValue is an enum value descriptor.

type Field

type Field interface {
	NamedDescriptor

	Message() Message
	Number() int
	Label() FieldDescriptorProtoLabel
	Type() FieldDescriptorProtoType
	TypeName() string
	// may be nil
	Oneof() Oneof
	Proto3Optional() bool
	JSONName() string
	JSType() FieldOptionsJSType
	CType() FieldOptionsCType
	// Set vs unset matters for packed
	// See the comments on descriptor.proto
	Packed() *bool

	NumberLocation() Location
	TypeLocation() Location
	TypeNameLocation() Location
	JSONNameLocation() Location
	JSTypeLocation() Location
	CTypeLocation() Location
	PackedLocation() Location
}

Field is a field descriptor.

type FieldDescriptorProtoLabel

type FieldDescriptorProtoLabel int32

FieldDescriptorProtoLabel aliases descriptorpb.FieldDescriptorProto_Label.

func (FieldDescriptorProtoLabel) String

func (l FieldDescriptorProtoLabel) String() string

String returns the string representation of the FieldDescriptorProtoLabel.

type FieldDescriptorProtoType

type FieldDescriptorProtoType int32

FieldDescriptorProtoType aliases descriptorpb.FieldDescriptorProto_Type.

func (FieldDescriptorProtoType) String

func (t FieldDescriptorProtoType) String() string

String returns the string representation of the FieldDescriptorProtoType.

type FieldOptionsCType

type FieldOptionsCType int32

FieldOptionsCType aliases descriptorpb.FieldOptions_CType.

func (FieldOptionsCType) String

func (c FieldOptionsCType) String() string

String returns the string representation of the FieldOptionsCType.

type FieldOptionsJSType

type FieldOptionsJSType int32

FieldOptionsJSType aliases descriptorpb.FieldOptions_JSType.

func (FieldOptionsJSType) String

func (j FieldOptionsJSType) String() string

String returns the string representation of the FieldOptionsJSType.

type File

type File interface {
	Descriptor
	FileInfo

	// Top-level only.
	ContainerDescriptor

	Syntax() Syntax
	Package() string
	FileImports() []FileImport
	Services() []Service

	CsharpNamespace() string
	GoPackage() string
	JavaMultipleFiles() bool
	JavaOuterClassname() string
	JavaPackage() string
	JavaStringCheckUtf8() bool
	ObjcClassPrefix() string
	PhpClassPrefix() string
	PhpNamespace() string
	PhpMetadataNamespace() string
	RubyPackage() string
	SwiftPrefix() string

	OptimizeFor() FileOptionsOptimizeMode
	CcGenericServices() bool
	JavaGenericServices() bool
	PyGenericServices() bool
	PhpGenericServices() bool
	CcEnableArenas() bool

	SyntaxLocation() Location
	PackageLocation() Location
	CsharpNamespaceLocation() Location
	GoPackageLocation() Location
	JavaMultipleFilesLocation() Location
	JavaOuterClassnameLocation() Location
	JavaPackageLocation() Location
	JavaStringCheckUtf8Location() Location
	ObjcClassPrefixLocation() Location
	PhpClassPrefixLocation() Location
	PhpNamespaceLocation() Location
	PhpMetadataNamespaceLocation() Location
	RubyPackageLocation() Location
	SwiftPrefixLocation() Location

	OptimizeForLocation() Location
	CcGenericServicesLocation() Location
	JavaGenericServicesLocation() Location
	PyGenericServicesLocation() Location
	PhpGenericServicesLocation() Location
	CcEnableArenasLocation() Location
}

File is a file descriptor.

func NewFile

func NewFile(inputFile InputFile) (File, error)

NewFile returns a new File.

func NewFilesUnstable

func NewFilesUnstable(ctx context.Context, inputFiles ...InputFile) ([]File, error)

NewFilesUnstable converts the input Files into Files.

This may be done concurrently and the returned Files may not be in the same order as the input FileDescriptors. If ordering matters, use NewFile.

type FileImport

type FileImport interface {
	LocationDescriptor

	Import() string
	IsPublic() bool
	IsWeak() bool
}

FileImport is a file import descriptor.

type FileInfo

type FileInfo interface {
	// Path is the path of the file relative to the root it is contained within.
	// This will be normalized, validated and never empty,
	// This will be unique within a given Image.
	Path() string

	//   Path: one/one.proto
	//   RootDirPath: proto
	//   ExternalPath: /foo/bar/proto/one/one.proto
	ExternalPath() string
}

FileInfo contains Protobuf file info.

type FileOptionsOptimizeMode

type FileOptionsOptimizeMode int32

FileOptionsOptimizeMode aliases descriptorpb.FileOptions_OptimizeMode.

func (FileOptionsOptimizeMode) String

func (t FileOptionsOptimizeMode) String() string

String returns the string representation of the FileOptionsOptimizeMode.

type InputFile

type InputFile interface {
	FileInfo
	// Proto is the backing FileDescriptorProto for this File.
	//
	// This will never be nil.
	// The value Path() is equal to Proto.GetName() .
	// The value ImportPaths() is equal to Proto().GetDependency().
	Proto() *descriptorpb.FileDescriptorProto
}

InputFile is an input file for NewFile.

func NewInputFileForProto

func NewInputFileForProto(fileDescriptorProto *descriptorpb.FileDescriptorProto) InputFile

NewInputFileForProto returns a new InputFile for the given FileDescriptorProto.

func NewInputFilesForProtos

func NewInputFilesForProtos(fileDescriptorProtos ...*descriptorpb.FileDescriptorProto) []InputFile

NewInputFilesForProtos returns new InputFiles for the given FileDescriptorProtos.

type Location

type Location interface {
	StartLine() int
	StartColumn() int
	EndLine() int
	EndColumn() int
	LeadingComments() string
	TrailingComments() string
	// NOT a copy. Do not modify.
	LeadingDetachedComments() []string
}

Location defines source code info location information.

May be extended in the future to include comments.

Note that unlike SourceCodeInfo_Location, these are not zero-indexed.

type LocationDescriptor

type LocationDescriptor interface {
	Descriptor

	// Location returns the location of the entire descriptor.
	//
	// Can return nil, although will generally not be nil.
	Location() Location
}

LocationDescriptor is the base interface for a descriptor type with a location.

type Message

type Message interface {
	NamedDescriptor
	// Only those directly nested under this message.
	ContainerDescriptor
	ReservedDescriptor

	// Includes fields in oneofs.
	Fields() []Field
	Extensions() []Field
	Oneofs() []Oneof
	ExtensionMessageRanges() []MessageRange
	ReservedMessageRanges() []MessageRange

	// Will return nil if this is a top-level message
	Parent() Message
	IsMapEntry() bool

	MessageSetWireFormat() bool
	NoStandardDescriptorAccessor() bool
	MessageSetWireFormatLocation() Location
	NoStandardDescriptorAccessorLocation() Location
}

Message is a message descriptor.

type MessageRange

type MessageRange interface {
	TagRange

	Message() Message
}

MessageRange is a TagRange for Messages.

func FreeMessageRanges

func FreeMessageRanges(message Message) []MessageRange

FreeMessageRanges returns the free message ranges for the given message.

Not recursive.

type Method

type Method interface {
	NamedDescriptor

	Service() Service
	InputTypeName() string
	OutputTypeName() string
	ClientStreaming() bool
	ServerStreaming() bool
	InputTypeLocation() Location
	OutputTypeLocation() Location

	IdempotencyLevel() MethodOptionsIdempotencyLevel
	IdempotencyLevelLocation() Location
}

Method is a method descriptor.

type MethodOptionsIdempotencyLevel

type MethodOptionsIdempotencyLevel int32

MethodOptionsIdempotencyLevel aliases descriptorpb.MethodOptions_IdempotencyLevel.

func (MethodOptionsIdempotencyLevel) String

func (t MethodOptionsIdempotencyLevel) String() string

String returns the string representation of the MethodOptionsIdempotencyLevel.

type NamedDescriptor

type NamedDescriptor interface {
	LocationDescriptor

	// FullName returns the fully-qualified name, i.e. some.pkg.Nested.Message.FooEnum.ENUM_VALUE.
	//
	// Always non-empty.
	FullName() string
	// NestedName returns the full nested name without the package, i.e. Nested.Message.FooEnum
	// or Nested.Message.FooEnum.ENUM_VALUE.
	//
	// Always non-empty.
	NestedName() string
	// Name returns the short name, or the name of a value or field, i.e. FooEnum or ENUM_VALUE.
	//
	// Always non-empty.
	Name() string
	// NameLocation returns the location of the name of the descriptor.
	//
	// If the backing descriptor does not have name-level resolution, this will
	// attempt to return a location of the entire descriptor.
	//
	// If the backing descriptor has comments for the entire descriptor, these
	// will be added to the named location.
	//
	// Can return nil.
	NameLocation() Location
}

NamedDescriptor is the base interface for a named descriptor type.

type Oneof

type Oneof interface {
	NamedDescriptor

	Message() Message
	Fields() []Field
}

Oneof is a oneof descriptor.

type ReservedDescriptor

type ReservedDescriptor interface {
	ReservedTagRanges() []TagRange
	ReservedNames() []ReservedName
}

ReservedDescriptor has reserved ranges and names.

type ReservedName

type ReservedName interface {
	LocationDescriptor

	Value() string
}

ReservedName is a reserved name for an enum or message.

type Service

type Service interface {
	NamedDescriptor

	Methods() []Method
}

Service is a service descriptor.

type Syntax

type Syntax int

Syntax is the syntax of a file.

const (
	// SyntaxProto2 represents the proto2 syntax.
	SyntaxProto2 Syntax = iota + 1
	// SyntaxProto3 represents the proto3 syntax.
	SyntaxProto3
)

func (Syntax) String

func (s Syntax) String() string

String returns the string representation of s

type TagRange

type TagRange interface {
	LocationDescriptor

	// Start is the start of the range.
	Start() int
	// End is the end of the range.
	// Inclusive.
	End() int
	// Max says that the End is the max.
	Max() bool
}

TagRange is a tag range from start to end.

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier