plugin

package

v0.5.4 Latest Latest Go to latest Published: Nov 3, 2025 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/katallaxie/htmx

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Plugin(ctx context.Context, path string, args ...string) htmx.Node
func Serve(opts *ServeOpts)
type Factory
type GRPCPlugin
- func (p *GRPCPlugin) Close() error
- func (p *GRPCPlugin) Render(ctx context.Context) (string, error)
type GRPCPluginFunc
type GRPCProviderPlugin
- func (p *GRPCProviderPlugin) GRPCClient(_ context.Context, _ *p.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
- func (p *GRPCProviderPlugin) GRPCServer(_ *p.GRPCBroker, s *grpc.Server) error
type Meta
- func (m *Meta) ExecutableFile() (string, error)
- func (m *Meta) Factory(ctx context.Context) Factory
type ServeOpts

Constants ¶

View Source

const (
	PluginName             = "plugin"
	DefaultProtocolVersion = 1
)

Variables ¶

View Source

var Handshake = p.HandshakeConfig{
	ProtocolVersion: DefaultProtocolVersion,

	MagicCookieKey:   "RUN_PLUGIN_MAGIC_COOKIE",
	MagicCookieValue: "iaafij5485d5utqh",
}

Handshake is configuring the handshake for the gRPC client.

View Source

var VersionedPlugins = map[int]p.PluginSet{
	1: {
		"plugin": &GRPCProviderPlugin{},
	},
}

Functions ¶

func Plugin ¶

func Plugin(ctx context.Context, path string, args ...string) htmx.Node

Plugin ...

func Serve ¶

func Serve(opts *ServeOpts)

Serve ...

Types ¶

type Factory ¶

type Factory func() (*GRPCPlugin, error)

Factory is creatig a new instance of the plugin.

type GRPCPlugin ¶

type GRPCPlugin struct {
	PluginClient *p.Client
	Meta         *Meta
	// contains filtered or unexported fields
}

GRPCPlugin contains the configuration and the client connection for the provider Plugin.

func (*GRPCPlugin) Close ¶

func (p *GRPCPlugin) Close() error

Close is closing the gRPC connection if a plugin is configured.

func (*GRPCPlugin) Render ¶

func (p *GRPCPlugin) Render(ctx context.Context) (string, error)

Render is rendering the plugin with the provided app and options.

type GRPCPluginFunc ¶

type GRPCPluginFunc func() proto.PluginServer

GRPCPluginFunc ...

type GRPCProviderPlugin ¶

type GRPCProviderPlugin struct {
	p.Plugin
	GRPCPlugin func() proto.PluginServer
}

GRPCProviderPlugin ...

func (*GRPCProviderPlugin) GRPCClient ¶

func (p *GRPCProviderPlugin) GRPCClient(_ context.Context, _ *p.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

GRPCClient ...

func (*GRPCProviderPlugin) GRPCServer ¶

func (p *GRPCProviderPlugin) GRPCServer(_ *p.GRPCBroker, s *grpc.Server) error

type Meta ¶

type Meta struct {
	// Path ...
	Path string
	// Arguments ...
	Arguments []string
}

Meta are the meta information provided for the plugin. These are the arguments and the path to the plugin.

func (*Meta) ExecutableFile ¶

func (m *Meta) ExecutableFile() (string, error)

ExecutableFile ...

func (*Meta) Factory ¶

func (m *Meta) Factory(ctx context.Context) Factory

Factory returns a factory function that can be used to create a new instance of the plugin.

type ServeOpts ¶

type ServeOpts struct {
	GRPCPluginFunc GRPCPluginFunc
}

ServeOpts ...

Source Files ¶

View all Source files

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