web

Documentation

Overview

Package web provides a web server with an HTTP API as well as a full UI to run amod code.

Index

• Variables
• type ErrFrameworkNotActive
  • func (e ErrFrameworkNotActive) Error() string
• type ErrInvalidFrameworkName
  • func (e ErrInvalidFrameworkName) Error() string
• type ErrInvalidModelID
  • func (e ErrInvalidModelID) Error() string
• type ErrInvalidSessionID
  • func (e ErrInvalidSessionID) Error() string
• type Model
• type Session
• type SessionList
• type Web
  • func Initialize(settings *cli.Settings, port int, examples *embed.FS) (w *Web, err error)
  • func (w Web) Start() (err error)

Variables

var (
	ErrEmptyRequestBody = errors.New("empty request body")
	ErrNoModel          = errors.New("no model loaded")
)

Types

type ErrFrameworkNotActive

type ErrFrameworkNotActive struct {
	Name string
}

func (ErrFrameworkNotActive) Error

func (e ErrFrameworkNotActive) Error() string

type ErrInvalidFrameworkName

type ErrInvalidFrameworkName struct {
	Name string
}

func (ErrInvalidFrameworkName) Error

func (e ErrInvalidFrameworkName) Error() string

type ErrInvalidModelID

type ErrInvalidModelID struct {
	ID int
}

func (ErrInvalidModelID) Error

func (e ErrInvalidModelID) Error() string

type ErrInvalidSessionID

type ErrInvalidSessionID struct {
	ID int
}

func (ErrInvalidSessionID) Error

func (e ErrInvalidSessionID) Error() string

type Model

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

type Session

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

type SessionList

type SessionList []*Session

type Web

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

func Initialize

func Initialize(settings *cli.Settings, port int, examples *embed.FS) (w *Web, err error)

func (Web) Start

func (w Web) Start() (err error)