bufremoteplugin

package
v1.61.2 Latest Latest
Warning

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

 Go to latest Published: Mar 2, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CargoRegistryConfigToProtoCargoConfig 

func CargoRegistryConfigToProtoCargoConfig(cargoConfig *bufremotepluginconfig.CargoRegistryConfig) (*registryv1alpha1.CargoConfig, error)

CargoRegistryConfigToProtoCargoConfig converts cargoConfig to an equivalent *registryv1alpha1.CargoConfig.

func CmakeRegistryConfigToProtoCmakeConfig 

func CmakeRegistryConfigToProtoCmakeConfig(cmakeConfig *bufremotepluginconfig.CmakeRegistryConfig) (*registryv1alpha1.CmakeConfig, error)

CmakeRegistryConfigToProtoCmakeConfig converts cmakeConfig to an equivalent *registryv1alpha1.CmakeConfig.

func DotnetTargetFrameworkFromString 

func DotnetTargetFrameworkFromString(framework string) (registryv1alpha1.DotnetTargetFramework, error)

DotnetTargetFrameworkFromString converts the target framework name to the equivalent enum. It returns an error if the specified string is unknown.

func DotnetTargetFrameworkToString 

func DotnetTargetFrameworkToString(framework registryv1alpha1.DotnetTargetFramework) (string, error)

DotnetTargetFrameworkToString converts the target framework enum to the equivalent string. It returns an error if the specified enum is unspecified or unknown.

func MavenDependencyConfigToProtoRuntimeLibrary 

func MavenDependencyConfigToProtoRuntimeLibrary(dependency bufremotepluginconfig.MavenDependencyConfig) *registryv1alpha1.MavenConfig_RuntimeLibrary

MavenDependencyConfigToProtoRuntimeLibrary converts a bufremotepluginconfig.MavenDependencyConfig to an equivalent registryv1alpha1.MavenConfig_RuntimeLibrary.

func MavenProtoRuntimeConfigToRuntimeConfig 

func MavenProtoRuntimeConfigToRuntimeConfig(proto *registryv1alpha1.MavenConfig_RuntimeConfig) (bufremotepluginconfig.MavenRuntimeConfig, error)

MavenProtoRuntimeConfigToRuntimeConfig converts a registryv1alpha1.MavenConfig_RuntimeConfig to a bufremotepluginconfig.MavenRuntimeConfig.

func MavenRuntimeConfigToProtoRuntimeConfig 

func MavenRuntimeConfigToProtoRuntimeConfig(runtime bufremotepluginconfig.MavenRuntimeConfig) *registryv1alpha1.MavenConfig_RuntimeConfig

MavenRuntimeConfigToProtoRuntimeConfig converts a bufremotepluginconfig.MavenRuntimeConfig to a registryv1alpha1.MavenConfig_RuntimeLibrary.

func NugetRegistryConfigToProtoNugetConfig 

func NugetRegistryConfigToProtoNugetConfig(nugetConfig *bufremotepluginconfig.NugetRegistryConfig) (*registryv1alpha1.NugetConfig, error)

NugetRegistryConfigToProtoNugetConfig converts nugetConfig to an equivalent *registryv1alpha1.NugetConfig.

func OutputLanguagesToProtoLanguages 

func OutputLanguagesToProtoLanguages(languages []string) ([]registryv1alpha1.PluginLanguage, error)

OutputLanguagesToProtoLanguages determines the appropriate registryv1alpha1.PluginRegistryType for the plugin.

func PluginIdentityToProtoCuratedPluginReference 

func PluginIdentityToProtoCuratedPluginReference(identity bufremotepluginref.PluginIdentity) *registryv1alpha1.CuratedPluginReference

PluginIdentityToProtoCuratedPluginReference converts a bufremotepluginref.PluginIdentity to a registryv1alpha1.CuratedPluginReference.

The returned CuratedPluginReference contains no Version/Revision information.

func PluginReferenceToProtoCuratedPluginReference 

func PluginReferenceToProtoCuratedPluginReference(reference bufremotepluginref.PluginReference) *registryv1alpha1.CuratedPluginReference

PluginReferenceToProtoCuratedPluginReference converts a bufremotepluginref.PluginReference to a registryv1alpha1.CuratedPluginReference.

func PluginReferencesToCuratedProtoPluginReferences 

func PluginReferencesToCuratedProtoPluginReferences(references []bufremotepluginref.PluginReference) []*registryv1alpha1.CuratedPluginReference

PluginReferencesToCuratedProtoPluginReferences converts a slice of bufremotepluginref.PluginReference to a slice of registryv1alpha1.CuratedPluginReference.

func PluginRegistryToProtoRegistryConfig 

func PluginRegistryToProtoRegistryConfig(pluginRegistry *bufremotepluginconfig.RegistryConfig) (*registryv1alpha1.RegistryConfig, error)

PluginRegistryToProtoRegistryConfig converts a bufremotepluginconfig.RegistryConfig to a registryv1alpha1.RegistryConfig.

func PluginToProtoPluginRegistryType 

func PluginToProtoPluginRegistryType(plugin Plugin) registryv1alpha1.PluginRegistryType

PluginToProtoPluginRegistryType determines the appropriate registryv1alpha1.PluginRegistryType for the plugin.

func ProtoCargoConfigToCargoRegistryConfig 

func ProtoCargoConfigToCargoRegistryConfig(protoCargoConfig *registryv1alpha1.CargoConfig) (*bufremotepluginconfig.CargoRegistryConfig, error)

ProtoCargoConfigToCargoRegistryConfig converts protoCargoConfig to an equivalent *bufremotepluginconfig.CargoRegistryConfig.

func ProtoCmakeConfigToCmakeRegistryConfig 

func ProtoCmakeConfigToCmakeRegistryConfig(protoCmakeConfig *registryv1alpha1.CmakeConfig) (*bufremotepluginconfig.CmakeRegistryConfig, error)

ProtoCmakeConfigToCmakeRegistryConfig converts protoCmakeConfig to an equivalent *bufremotepluginconfig.CmakeRegistryConfig.

func ProtoMavenConfigToMavenRegistryConfig 

func ProtoMavenConfigToMavenRegistryConfig(protoMavenConfig *registryv1alpha1.MavenConfig) (*bufremotepluginconfig.MavenRegistryConfig, error)

ProtoMavenConfigToMavenRegistryConfig converts a registryv1alpha1.MavenConfig to a bufremotepluginconfig.MavenRegistryConfig.

func ProtoMavenRuntimeLibraryToDependencyConfig 

func ProtoMavenRuntimeLibraryToDependencyConfig(proto *registryv1alpha1.MavenConfig_RuntimeLibrary) bufremotepluginconfig.MavenDependencyConfig

ProtoMavenRuntimeLibraryToDependencyConfig converts a registryv1alpha1 to a bufremotepluginconfig.MavenDependencyConfig.

func ProtoNugetConfigToNugetRegistryConfig 

func ProtoNugetConfigToNugetRegistryConfig(protoConfig *registryv1alpha1.NugetConfig) (*bufremotepluginconfig.NugetRegistryConfig, error)

ProtoNugetConfigToNugetRegistryConfig converts protoConfig to an equivalent *bufremotepluginconfig.NugetRegistryConfig.

func ProtoPythonConfigToPythonRegistryConfig 

func ProtoPythonConfigToPythonRegistryConfig(protoPythonConfig *registryv1alpha1.PythonConfig) (*bufremotepluginconfig.PythonRegistryConfig, error)

ProtoPythonConfigToPythonRegistryConfig converts protoPythonConfig to an equivalent *bufremotepluginconfig.PythonRegistryConfig.

func ProtoRegistryConfigToPluginRegistry 

func ProtoRegistryConfigToPluginRegistry(config *registryv1alpha1.RegistryConfig) (*bufremotepluginconfig.RegistryConfig, error)

ProtoRegistryConfigToPluginRegistry converts a registryv1alpha1.RegistryConfig to a bufremotepluginconfig.RegistryConfig .

func ProtoSwiftConfigToSwiftRegistryConfig 

func ProtoSwiftConfigToSwiftRegistryConfig(protoSwiftConfig *registryv1alpha1.SwiftConfig) (*bufremotepluginconfig.SwiftRegistryConfig, error)

ProtoSwiftConfigToSwiftRegistryConfig converts protoSwiftConfig to an equivalent *bufremotepluginconfig.SwiftRegistryConfig.

func PythonRegistryConfigToProtoPythonConfig 

func PythonRegistryConfigToProtoPythonConfig(pythonConfig *bufremotepluginconfig.PythonRegistryConfig) (*registryv1alpha1.PythonConfig, error)

PythonRegistryConfigToProtoPythonConfig converts pythonConfig to an equivalent *registryv1alpha1.PythonConfig.

func SwiftRegistryConfigToProtoSwiftConfig 

func SwiftRegistryConfigToProtoSwiftConfig(swiftConfig *bufremotepluginconfig.SwiftRegistryConfig) *registryv1alpha1.SwiftConfig

SwiftRegistryConfigToProtoSwiftConfig converts swiftConfig to an equivalent *registryv1alpha1.SwiftConfig.

Types

type Plugin 

type Plugin interface {
	// Version is the version of the plugin's implementation
	// (e.g. the protoc-gen-connect-go implementation is v0.2.0).
	Version() string
	// SourceURL is an optional attribute used to specify where the source
	// for the plugin can be found.
	SourceURL() string
	// Description is an optional attribute to provide a more detailed
	// description for the plugin.
	Description() string
	// Dependencies are the dependencies this plugin has on other plugins.
	//
	// An example of a dependency might be a 'protoc-gen-go-grpc' plugin
	// which depends on the 'protoc-gen-go' generated code.
	Dependencies() []bufremotepluginref.PluginReference
	// Registry is the registry configuration, which lets the user specify
	// registry dependencies, and other metadata that applies to a specific
	// remote generation registry (e.g. the Go module proxy, NPM registry,
	// etc).
	Registry() *bufremotepluginconfig.RegistryConfig
	// ContainerImageDigest returns the plugin's source image digest.
	//
	// For now, we only support docker image sources, but this
	// might evolve to support others later on.
	ContainerImageDigest() string
}

Plugin represents a plugin defined by a buf.plugin.yaml.

func NewPlugin 

func NewPlugin(
	version string,
	dependencies []bufremotepluginref.PluginReference,
	registryConfig *bufremotepluginconfig.RegistryConfig,
	imageDigest string,
	sourceURL string,
	description string,
) (Plugin, error)

NewPlugin creates a new plugin from the given configuration and image digest.

Source Files

View all Source files

Directories

Path Synopsis
Package bufremotepluginconfig defines the buf.plugin.yaml file.
 Package bufremotepluginconfig defines the buf.plugin.yaml file.
Package bufremoteplugindocker contains utilities for building Buf plugins using the Docker API.
 Package bufremoteplugindocker contains utilities for building Buf plugins using the Docker API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.