garden

Documentation

Index

• type Context
  • func NewContext() Context
• type Gardener
  • func NewGardener(ctx Context, roamDir roam.Directory) (*Gardener, error)
  • func (g Gardener) Plant(ctx Context, stub roam.Stub) error

Types

type Context

type Context interface {
	roam.Context

	// GardenDir is the directory that the garden is planted in.
	GardenDir() string
}

Context represents values needed by the garden.

func NewContext

func NewContext() Context

NewContext returns a new garden context.

type Gardener

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

Gardener plants nodes in the garden.

func NewGardener

func NewGardener(ctx Context, roamDir roam.Directory) (*Gardener, error)

NewGardener returns a new gardener and builds backlings from the given roam directory.

func (Gardener) Plant

func (g Gardener) Plant(ctx Context, stub roam.Stub) error

Plants puts a note in a garden.