plugin

package
v0.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 5, 2024 License: Apache-2.0 Imports: 42 Imported by: 0

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

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

Variables

Functions

This section is empty.

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 added in v0.3.0

type ActionDescriptor = descriptor.ActionDescriptor

type CommandDescriptor added in v0.12.0

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 added in v0.4.1

type ValueMergeHandlerDescriptor = descriptor.ValueMergeHandlerDescriptor

type ValueSetDefinition added in v0.4.1

type ValueSetDefinition = descriptor.ValueSetDefinition

type ValueSetDescriptor added in v0.4.1

type ValueSetDescriptor = descriptor.ValueSetDescriptor

Directories

Path Synopsis
Package cache implements the plugin cache that contains all loaded plugins.
Package cache implements the plugin cache that contains all loaded plugins.
Package descriptor declares several structs that describe the information that formally describes the capabilities provided by each plugin.
Package descriptor declares several structs that describe the information that formally describes the capabilities provided by each plugin.
ppi
Package ppi provides the plugin programming interface.
Package ppi provides the plugin programming interface.
config
The config package can be used if the plugin should provide the ocm configuration from the calling OCM library.
The config package can be used if the plugin should provide the ocm configuration from the calling OCM library.
logging
The logging package can be used if the plugin should handle the ocm logging configuration from the calling OCM library.
The logging package can be used if the plugin should handle the ocm logging configuration from the calling OCM library.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL