interfaces

Documentation

Overview

Copyright 2022 Google LLC

Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.

Copyright 2022 Google LLC

Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.

Index

• type Exporter
• type FileSystem
• type QueryCommand
• type Writer

Types

type Exporter

type Exporter interface {
	// Export will write the converted Bazel cquery response data to
	// a new project format.
	Export(qcmd QueryCommand) error
}

Exporter defines an interface for exporting the Bazel workspace rules to a different project format.

type FileSystem

type FileSystem interface {
	// OpenFile defines a function responsible for opening a file with
	// write access identified by the absolute path.
	OpenFile(path string) (Writer, error)

	// ReadFile defines a function responsible for reading the entire
	// contents of a file from disk.
	ReadFile(filename string) ([]byte, error)
}

FileSystem defines an interface for interacting with the underlying OS filesystem.

type QueryCommand

type QueryCommand interface {
	// Read will return the response data for a `bazel [cquery|query] ...`
	// invocation.
	Read() ([]byte, error)
}

QueryCommand defines an interface for returning the response of a Bazel query or cquery call.

type Writer

type Writer interface {
	io.StringWriter
	io.Writer
}

Writer is an interface that groups io.StringWriter and io.Writer to enable simpler writing of the exported Bazel output text.