app

Documentation

Index

• type App
  • func New(name, dataDir string, opts ...Option) (*App, error)
  • func (app *App) Run(args []string) error
• type Option
  • func WithContext(ctx context.Context) Option
  • func WithDB(d *db.DB) Option
  • func WithEnv(env actx.Environment) Option
  • func WithFDs(stdin io.Reader, stdout, stderr io.Writer) Option
  • func WithFS(fs vfs.FileSystem) Option
  • func WithLogger(isStdoutTTY, isStderrTTY bool) Option
  • func WithStore(store store.Store) Option
  • func WithUser(user *models.User) Option

Types

type App

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

App is the application.

func New

func New(name, dataDir string, opts ...Option) (*App, error)

New initializes a new application with the given options. dataDir specifies the directory where application data will be stored, though this can be overriden with the DISCO_DATA_DIR environment variable, and --data-dir CLI flag.

func (*App) Run

func (app *App) Run(args []string) error

Run initializes the application environment and starts execution of the application.

type Option

type Option func(*App)

Option is a function that allows configuring the application.

func WithContext

func WithContext(ctx context.Context) Option

WithContext sets the main context.

func WithDB

func WithDB(d *db.DB) Option

WithDB sets the main Disco database.

func WithEnv

func WithEnv(env actx.Environment) Option

WithEnv sets the process environment used by the application.

func WithFDs

func WithFDs(stdin io.Reader, stdout, stderr io.Writer) Option

WithFDs sets the file descriptors used by the application.

func WithFS

func WithFS(fs vfs.FileSystem) Option

WithFS sets the filesystem used by the application.

func WithLogger

func WithLogger(isStdoutTTY, isStderrTTY bool) Option

WithLogger initializes the logger used by the application.

func WithStore

func WithStore(store store.Store) Option

WithStore sets the key-value store.

func WithUser

func WithUser(user *models.User) Option

WithUser sets the local user of the app.