bufimage

type File interface {
	FileRef
	// ImportRootRelFilePaths returns the root relative file paths of the imports.
	//
	// The values will be normalized, validated, and never empty.
	// This is equal to Proto.GetDependency().
	ImportRootRelFilePaths() []string
	// Proto is the backing FileDescriptorProto for this File.
	//
	// This will never be nil.
	// The value RootRelFilePath() is equal to Proto.GetName() .
	// The value ImportRootRelFilePaths() is equal to Proto().GetDependency().
	Proto() *descriptorpb.FileDescriptorProto
	// IsImport returns true if this file is an import in the context of the enclosing Image.
	IsImport() bool
	// contains filtered or unexported methods
}

type FileRef interface {
	// RootRelFilePath 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.
	RootRelFilePath() string
	// RootDirPath is the directory path of the root that contains this file.
	//
	// This will be normalized, validated and never empty,
	// The full relative path to the file within a given context is normalpath.Join(RootDirPath(), RootRelFilePath())
	// For FileRefs created from external images, this will always be ".".
	//
	// This path should be used for informational purposes only and not
	// used to help uniquely identify a file within an Image.
	RootDirPath() string
	// ExternalFilePath returns the path that identifies this file externally.
	//
	// Example:
	//   RootRelFilePath: one/one.proto
	//   RootDirPath: proto
	//   DirectoryPath: /foo/bar
	//   ExternalFilePath: /foo/bar/proto/one/one.proto
	ExternalFilePath() string
	// contains filtered or unexported methods
}

type Image interface {
	// Files are the files that comprise the image.
	//
	// This contains all files, including imports if available.
	// The returned files are in correct DAG order.
	Files() []File
	// GetFile gets the file for the root relative file path.
	//
	// If the file does not exist, nil is returned.
	// The rootRelFilePath is expected to be normalized and validated.
	// Note that all values of GetDependency() can be used here.
	GetFile(rootRelFilePath string) File
}