lifecycler

Documentation

Index

• type CaddyfileInfo
• type LifeCyclable
• type LifeCycler
  • func (l *LifeCycler[T]) Cleanup() (err error)
  • func (*LifeCycler[T]) MarshalJSON() ([]byte, error)
  • func (l *LifeCycler[T]) Provision(ctx caddy.Context, info *ProvisionInfo) error
  • func (l *LifeCycler[T]) SetValue(v T)
  • func (l *LifeCycler[T]) Start() error
  • func (l *LifeCycler[T]) UnmarshalCaddyfile(d *caddyfile.Dispenser, info *CaddyfileInfo) error
  • func (*LifeCycler[T]) UnmarshalJSON([]byte) error
• type ProvisionInfo

Types

type CaddyfileInfo

type CaddyfileInfo struct {
	ModuleID           string // module.id.path. with dot at end if required
	Raw                *[]json.RawMessage
	SubModuleSpecifier string
	ParseVerbLine      caddyfile.Unmarshaler
}

type LifeCyclable

type LifeCyclable[T any] interface {
	caddy.Module
	Start(T) error
}

type LifeCycler

type LifeCycler[T any] struct {
	V       T
	Modules []LifeCyclable[T]
	Started []LifeCyclable[T]
}

func (*LifeCycler[T]) Cleanup

func (l *LifeCycler[T]) Cleanup() (err error)

func (*LifeCycler[T]) MarshalJSON

func (*LifeCycler[T]) MarshalJSON() ([]byte, error)

func (*LifeCycler[T]) Provision

func (l *LifeCycler[T]) Provision(ctx caddy.Context, info *ProvisionInfo) error

func (*LifeCycler[T]) SetValue

func (l *LifeCycler[T]) SetValue(v T)

func (*LifeCycler[T]) Start

func (l *LifeCycler[T]) Start() error

func (*LifeCycler[T]) UnmarshalCaddyfile

func (l *LifeCycler[T]) UnmarshalCaddyfile(d *caddyfile.Dispenser, info *CaddyfileInfo) error

UnmarshalCaddyfile unmarshals a module from a caddyfile.

{
  <verb> [rest of line] {
    <submodule name> <submodule config>
  }
}

func (*LifeCycler[T]) UnmarshalJSON

func (*LifeCycler[T]) UnmarshalJSON([]byte) error

type ProvisionInfo

type ProvisionInfo struct {
	StructPointer any
	FieldName     string
	Raw           *[]json.RawMessage
}