bufcore

Documentation

Overview

Package bufcore contains core types.

Index

• type FileInfo
  • func NewFileInfo(path string, externalPath string, isImport bool) (FileInfo, error)
  • func NewFileInfoForObjectInfo(objectInfo storage.ObjectInfo, isImport bool) FileInfo

Types

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
	// IsImport returns true if this file is an import.
	IsImport() bool

	// WithIsImport returns this FileInfo with the given IsImport value.
	WithIsImport(isImport bool) FileInfo
	// contains filtered or unexported methods
}

FileInfo contains protobuf file info.

func NewFileInfo

func NewFileInfo(path string, externalPath string, isImport bool) (FileInfo, error)

NewFileInfo returns a new FileInfo.

If externalPath is empty, path is used.

func NewFileInfoForObjectInfo

func NewFileInfoForObjectInfo(objectInfo storage.ObjectInfo, isImport bool) FileInfo

NewFileInfoForObjectInfo returns a new FileInfo for the storage.ObjectInfo.

The same rules apply to ObjectInfos for paths as FileInfos so we do not need to validate.