file

Documentation

Index

• Variables
• 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
• type Detector
  • func (ut Detector) MarshalText() (text []byte, err error)
  • func (ut Detector) String() string
  • func (ut *Detector) UnmarshalText(text []byte) error
• type Exports

Variables

var DefaultArguments = Arguments{
	Type:          DetectorFSNotify,
	PollFrequency: time.Minute,
}

DefaultArguments provides the default arguments for the local.file component.

Types

type Arguments

type Arguments struct {
	// Filename indicates the file to watch.
	Filename string `river:"filename,attr"`
	// Type indicates how to detect changes to the file.
	Type Detector `river:"detector,attr,optional"`
	// PollFrequency determines the frequency to check for changes when Type is
	// Poll.
	PollFrequency time.Duration `river:"poll_frequency,attr,optional"`
	// IsSecret marks the file as holding a secret value which should not be
	// displayed to the user.
	IsSecret bool `river:"is_secret,attr,optional"`
}

Arguments holds values which are used to configure the local.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 local.file component.

func New

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

New creates a new local.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.

type Detector

type Detector int

Detector is used to specify how changes to the file should be detected.

const (
	// DetectorInvalid indicates an invalid UpdateType.
	DetectorInvalid Detector = iota
	// DetectorFSNotify uses filesystem events to wait for changes to the file.
	DetectorFSNotify
	// DetectorPoll will re-read the file on an interval to detect changes.
	DetectorPoll

	// DetectorDefault holds the default UpdateType.
	DetectorDefault = DetectorFSNotify
)

func (Detector) MarshalText

func (ut Detector) MarshalText() (text []byte, err error)

MarshalText implements encoding.TextMarshaler.

func (Detector) String

func (ut Detector) String() string

String returns the string representation of the UpdateType.

func (*Detector) UnmarshalText

func (ut *Detector) UnmarshalText(text []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

type Exports

type Exports struct {
	// Content of the file.
	Content rivertypes.OptionalSecret `river:"content,attr"`
}

Exports holds values which are exported by the local.file component.