file

Documentation

Index

• type Arguments
  • func (a *Arguments) SetToDefault()
• type Component
  • func New(o component.Options, args Arguments) (*Component, error)
  • func (c *Component) CurrentHealth() component.Health
  • func (c *Component) Run(ctx context.Context) error
  • func (c *Component) Update(args component.Arguments) error

Types

type Arguments

type Arguments struct {
	LocalFileArguments file.Arguments `river:",squash"`

	// Arguments to pass into the module.
	Arguments map[string]any `river:"arguments,block,optional"`
}

Arguments holds values which are used to configure the module.file component.

func (*Arguments) SetToDefault

func (a *Arguments) SetToDefault()

SetToDefault implements river.Defaulter.

type Component

type Component struct {
	// contains filtered or unexported fields
}

Component implements the module.file component.

func New

func New(o component.Options, args Arguments) (*Component, error)

New creates a new module.file component.

func (*Component) CurrentHealth

func (c *Component) CurrentHealth() component.Health

CurrentHealth implements component.HealthComponent.

func (*Component) Run

func (c *Component) Run(ctx context.Context) error

Run implements component.Component.

func (*Component) Update

func (c *Component) Update(args component.Arguments) error

Update implements component.Component.