mode

Documentation

Index

• type FileModeDiff
  • func (diff *FileModeDiff) Changes() bool
  • func (diff *FileModeDiff) Current() string
  • func (diff *FileModeDiff) Original() string
• type Mode
  • func (t *Mode) Apply(context.Context) (resource.TaskStatus, error)
  • func (t *Mode) Check(context.Context, resource.Renderer) (resource.TaskStatus, error)
  • func (t *Mode) Validate() error
• type Preparer
  • func (p *Preparer) Prepare(ctx context.Context, render resource.Renderer) (resource.Task, error)

Types

type FileModeDiff

type FileModeDiff struct {
	Actual   os.FileMode
	Expected os.FileMode
}

FileModeDiff shows a diff of the file modes

func (*FileModeDiff) Changes

func (diff *FileModeDiff) Changes() bool

Changes returns true if the expected file mode differs from the current mode

func (*FileModeDiff) Current

func (diff *FileModeDiff) Current() string

Current shows the current file mode

func (*FileModeDiff) Original

func (diff *FileModeDiff) Original() string

Original shows the original file mode

type Mode

type Mode struct {
	resource.Status

	// path to the file that will be modified
	Destination string `export:"destination"`

	// the mode that the file or directory should be configured with
	Mode os.FileMode `export:"mode"`
}

Mode monitors the mode of a file

func (*Mode) Apply

func (t *Mode) Apply(context.Context) (resource.TaskStatus, error)

Apply the changes the Mode

func (*Mode) Check

func (t *Mode) Check(context.Context, resource.Renderer) (resource.TaskStatus, error)

Check whether the Destination has the right Mode

func (*Mode) Validate

func (t *Mode) Validate() error

Validate Mode

type Preparer

type Preparer struct {
	// Destination specifies which file will be modified by this resource. The
	// file must exist on the system (for example, having been created with
	// `file.content`.)
	Destination string `hcl:"destination" required:"true" nonempty:"true"`

	// Mode is the mode of the file, specified in octal.
	Mode *uint32 `hcl:"mode" base:"8" required:"true"`
}

Preparer for file Mode

Mode monitors the mode of a file

func (*Preparer) Prepare

func (p *Preparer) Prepare(ctx context.Context, render resource.Renderer) (resource.Task, error)

Prepare this resource for use