plugin

Documentation

Overview

Package plugin maps a Go plugin interface to a technical command line interface. Thereby, it allows to embed plugins and their provided functionality into the library. It is the basis for adapter implementations for accessmethods, downloaders, uploaders, blob handlers, actions, value mergers and label merge specifications. Those adapters can be found in the subpackage "plugin" of their dedicated functional area packages (e.g. pkg/contexts/ocm/accessmethods/plugin).

Index

• Constants
• Variables
• type AccessDataWriter
  • func NewAccessDataWriter(p Plugin, creds, accspec json.RawMessage) *AccessDataWriter
  • func (d *AccessDataWriter) WriteTo(w accessio.Writer) (int64, digest.Digest, error)
• type AccessMethodDescriptor
• type AccessSpecInfo
• type ActionDescriptor
• type CommandDescriptor
• type Descriptor
• type DownloaderDescriptor
• type DownloaderKey
• type Plugin
  • func NewPlugin(ctx ocm.Context, impl cache.Plugin, config json.RawMessage) Plugin
• type UploadTargetSpecInfo
• type UploaderDescriptor
• type UploaderKey
• type UploaderKeySet
• type ValueMergeHandlerDescriptor
• type ValueSetDefinition
• type ValueSetDescriptor

Constants

const (
	KIND_PLUGIN       = descriptor.KIND_PLUGIN
	KIND_UPLOADER     = descriptor.KIND_UPLOADER
	KIND_ACCESSMETHOD = descriptor.KIND_ACCESSMETHOD
	KIND_ACTION       = descriptor.KIND_ACTION
)

Variables

var TAG = descriptor.REALM

Types

type AccessDataWriter

type AccessDataWriter struct {
	// contains filtered or unexported fields
}

func NewAccessDataWriter

func NewAccessDataWriter(p Plugin, creds, accspec json.RawMessage) *AccessDataWriter

func (*AccessDataWriter) WriteTo

func (d *AccessDataWriter) WriteTo(w accessio.Writer) (int64, digest.Digest, error)

type AccessMethodDescriptor

type AccessMethodDescriptor = descriptor.AccessMethodDescriptor

type AccessSpecInfo

type AccessSpecInfo = internal.AccessSpecInfo

type ActionDescriptor

type ActionDescriptor = descriptor.ActionDescriptor

type CommandDescriptor

type CommandDescriptor = descriptor.CommandDescriptor

type Descriptor

type Descriptor = descriptor.Descriptor

type DownloaderDescriptor

type DownloaderDescriptor = descriptor.DownloaderDescriptor

type DownloaderKey

type DownloaderKey = descriptor.DownloaderKey

type Plugin

type Plugin = *pluginImpl

func NewPlugin

func NewPlugin(ctx ocm.Context, impl cache.Plugin, config json.RawMessage) Plugin

type UploadTargetSpecInfo

type UploadTargetSpecInfo = internal.UploadTargetSpecInfo

type UploaderDescriptor

type UploaderDescriptor = descriptor.UploaderDescriptor

type UploaderKey

type UploaderKey = descriptor.UploaderKey

type UploaderKeySet

type UploaderKeySet = descriptor.UploaderKeySet

type ValueMergeHandlerDescriptor

type ValueMergeHandlerDescriptor = descriptor.ValueMergeHandlerDescriptor

type ValueSetDefinition

type ValueSetDefinition = descriptor.ValueSetDefinition

type ValueSetDescriptor

type ValueSetDescriptor = descriptor.ValueSetDescriptor