core

Documentation

Index

• func GUnzippedBytes(input []byte) ([]byte, error)
• func GZippedBytes(input []byte) ([]byte, error)
• func GetArtifactMessageContents(artifact *rpc.Artifact) (proto.Message, error)
• func GetBytesForSpec(ctx context.Context, client connection.RegistryClient, spec *rpc.ApiSpec) ([]byte, error)
• func IsPrintableType(mimeType string) bool
• func PrintMessage(message proto.Message)
• func SetArtifact(ctx context.Context, client *gapic.RegistryClient, artifact *rpc.Artifact) error
• func UnzipArchiveToMap(b []byte) (map[string][]byte, error)
• func UnzipArchiveToPath(b []byte, dest string) ([]string, error)
• func VerifyLocation(ctx context.Context, client connection.RegistryClient, location string) error
• func WorkerPool(ctx context.Context, n int) (chan<- Task, func())
• func WorkerPoolWithWarnings(ctx context.Context, n int) (chan<- Task, func())
• func ZipArchiveOfFiles(files []string, prefix string, recursive bool) (buf bytes.Buffer, err error)
• func ZipArchiveOfPath(path, prefix string, recursive bool) (buf bytes.Buffer, err error)
• type Labeling
  • func (l *Labeling) Apply(m map[string]string) (map[string]string, error)
• type Task

Functions

func GUnzippedBytes

func GUnzippedBytes(input []byte) ([]byte, error)

GUnzippedBytes uncompresses a slice of bytes.

func GZippedBytes

func GZippedBytes(input []byte) ([]byte, error)

GZippedBytes compresses a slice of bytes.

func GetArtifactMessageContents

func GetArtifactMessageContents(artifact *rpc.Artifact) (proto.Message, error)

func GetBytesForSpec

func GetBytesForSpec(ctx context.Context, client connection.RegistryClient, spec *rpc.ApiSpec) ([]byte, error)

func IsPrintableType

func IsPrintableType(mimeType string) bool

func PrintMessage

func PrintMessage(message proto.Message)

func SetArtifact

func SetArtifact(ctx context.Context,
	client *gapic.RegistryClient,
	artifact *rpc.Artifact) error

func UnzipArchiveToMap

func UnzipArchiveToMap(b []byte) (map[string][]byte, error)

UnzipArchiveToMap will decompress a zip archive to a map. May be memory intensive for large zip archives.

func UnzipArchiveToPath

func UnzipArchiveToPath(b []byte, dest string) ([]string, error)

UnzipArchiveToPath will decompress a zip archive, writing all files and folders within the zip archive (parameter 1) to an output directory (parameter 2). Based on an example published at https://golangcode.com/unzip-files-in-go/

func VerifyLocation

func VerifyLocation(ctx context.Context, client connection.RegistryClient, location string) error

func WorkerPool

func WorkerPool(ctx context.Context, n int) (chan<- Task, func())

This function creates a waitgroup and a taskQueue for the workerPool. It will create "n" workers which will listen for Tasks on the taskQueue. It returns the taskQueue and a wait func. The clients should add new tasks to this taskQueue and call the call the wait func when done. Do not separately close the taskQueue, make use of the wait func.

func WorkerPoolWithWarnings

func WorkerPoolWithWarnings(ctx context.Context, n int) (chan<- Task, func())

Similar to WorkerPool except it creates workers which log task errors as "Warnings"

func ZipArchiveOfFiles

func ZipArchiveOfFiles(files []string, prefix string, recursive bool) (buf bytes.Buffer, err error)

ZipArchiveOfFiles stores a list of files in a zip archive. The specified prefix is stripped from file names in the archive.

func ZipArchiveOfPath

func ZipArchiveOfPath(path, prefix string, recursive bool) (buf bytes.Buffer, err error)

ZipArchiveOfPath reads the contents of a path into a zip archive. The specified prefix is stripped from file names in the archive. Based on an example published at https://golangcode.com/create-zip-files-in-go/

Types

type Labeling

type Labeling struct {
	Overwrite bool
	Set       map[string]string
	Clear     []string
}

Labeling represents a user-specified change to a set of labels or annotations. Note that this same structure is used for both labels and annotations.

func (*Labeling) Apply

func (l *Labeling) Apply(m map[string]string) (map[string]string, error)

Apply applies a labeling to a map. It returns the modified map because it creates the map if nil is passed in.

type Task

type Task interface {
	Run(ctx context.Context) error
	String() string
}

Task is a generic interface for a runnable operation