plugin

Documentation

Index

• Variables
• type BacktraceFrame
• type MethodArgs
• type MethodResult
• type MethodSpec
• type MethodType
• type PanicInfo
• type Plugin

Variables

var (
	// Register register a new kcl plugin.
	RegisterPlugin = plugin.RegisterPlugin
	// GetPlugin get plugin object by name.
	GetPlugin = plugin.GetPlugin
	// GetMethodSpec get plugin method by name.
	GetMethodSpec = plugin.GetMethodSpec
	// ResetPlugin reset all kcl plugin state.
	ResetPlugin = plugin.ResetPlugin
)

var (
	GetInvokeJsonProxyPtr = plugin.GetInvokeJsonProxyPtr
	Invoke                = plugin.Invoke
	InvokeJson            = plugin.InvokeJson
)

var (
	JSONError = plugin.JSONError
)

var (
	// ParseMethodArgs parses JSON strings for positional and keyword arguments
	// and returns a MethodArgs object.
	// args_json: JSON string of positional arguments
	// kwargs_json: JSON string of keyword arguments
	ParseMethodArgs = plugin.ParseMethodArgs
)

Types

type BacktraceFrame

type BacktraceFrame = plugin.BacktraceFrame

type MethodArgs

type MethodArgs = plugin.MethodArgs

MethodArgs represents the arguments passed to a KCL Plugin method. It includes a list of positional arguments and a map of keyword arguments.

type MethodResult

type MethodResult = plugin.MethodResult

MethodResult represents the result returned from a KCL Plugin method. It holds the value of the result.

type MethodSpec

type MethodSpec = plugin.MethodSpec

MethodSpec defines the specification for a KCL Plugin method. It includes the method type and the body function which executes the method logic.

type MethodType

type MethodType = plugin.MethodType

MethodType describes the type of a KCL Plugin method's arguments, keyword arguments, and result. It specifies the types of positional arguments, keyword arguments, and the result type.

type PanicInfo

type PanicInfo = plugin.PanicInfo

type Plugin

type Plugin = plugin.Plugin

Plugin represents a KCL Plugin with metadata and methods. It contains the plugin name, version, a reset function, and a map of methods.