directory

Documentation

Index

• type Directory
  • func (d *Directory) Apply(context.Context) (resource.TaskStatus, error)
  • func (d *Directory) Check(context.Context, resource.Renderer) (resource.TaskStatus, error)
• type Preparer
  • func (p *Preparer) Prepare(ctx context.Context, render resource.Renderer) (resource.Task, error)

Types

type Directory

type Directory struct {
	resource.TaskStatus

	// directory path
	Destination string `export:"destination"`

	// if true, directories will be created recursively
	CreateAll bool `export:"createall"`
}

Directory makes sure a directory is present on disk

func (*Directory) Apply

func (d *Directory) Apply(context.Context) (resource.TaskStatus, error)

Apply creates the directory

func (*Directory) Check

func (d *Directory) Check(context.Context, resource.Renderer) (resource.TaskStatus, error)

Check if the directory exists

type Preparer

type Preparer struct {
	// the location on disk to make the directory
	Destination string `hcl:"destination" required:"true" nonempty:"true"`

	// whether or not to create all parent directories on the way up
	CreateAll bool `hcl:"create_all"`
}

Preparer for Directory

Directory makes sure a directory is present on disk

func (*Preparer) Prepare

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

Prepare the new directory