model

Documentation

Index

• type CreateTask
• type CreateTaskBatch
• type InstallExtension
• type RespCode
• type Result
  • func NewErrorResult(msg string, code ...RespCode) *Result[any]
  • func NewNilResult() *Result[any]
  • func NewOkResult[T any](data T) *Result[T]
• type StartConfig
  • func (cfg *StartConfig) Init() *StartConfig
• type Storage
• type SwitchExtension
• type UpdateCheckExtensionResp
• type UpdateExtensionSettings
• type WebBasicAuth
  • func (cfg *WebBasicAuth) Authorization() string

Types

type CreateTask

type CreateTask struct {
	Rid string        `json:"rid"`
	Req *base.Request `json:"req"`
	Opt *base.Options `json:"opt"`
}

type CreateTaskBatch

type CreateTaskBatch struct {
	Reqs []*base.Request `json:"reqs"`
	Opt  *base.Options   `json:"opt"`
}

type InstallExtension

type InstallExtension struct {
	DevMode bool   `json:"devMode"`
	URL     string `json:"url"`
}

type RespCode

type RespCode int

const (
	CodeOk RespCode = 0
	// CodeError is the common error code
	CodeError RespCode = 1000
	// CodeUnauthorized is the error code for unauthorized
	CodeUnauthorized RespCode = 1001
	// CodeInvalidParam is the error code for invalid parameter
	CodeInvalidParam RespCode = 1002
	// CodeTaskNotFound is the error code for task not found
	CodeTaskNotFound RespCode = 2001
)

type Result

type Result[T any] struct {
	Code RespCode `json:"code"`
	Msg  string   `json:"msg"`
	Data T        `json:"data"`
}

func NewErrorResult

func NewErrorResult(msg string, code ...RespCode) *Result[any]

func NewNilResult

func NewNilResult() *Result[any]

func NewOkResult

func NewOkResult[T any](data T) *Result[T]

type StartConfig

type StartConfig struct {
	Network           string                      `json:"network"`
	Address           string                      `json:"address"`
	RefreshInterval   int                         `json:"refreshInterval"`
	Storage           Storage                     `json:"storage"`
	StorageDir        string                      `json:"storageDir"`
	WhiteDownloadDirs []string                    `json:"whiteDownloadDirs"`
	ApiToken          string                      `json:"apiToken"`
	DownloadConfig    *base.DownloaderStoreConfig `json:"downloadConfig"`

	ProductionMode bool

	WebEnable    bool
	WebFS        fs.FS
	WebBasicAuth *WebBasicAuth
}

func (*StartConfig) Init

func (cfg *StartConfig) Init() *StartConfig

type Storage

type Storage string

const (
	StorageMem  Storage = "mem"
	StorageBolt Storage = "bolt"
)

type SwitchExtension

type SwitchExtension struct {
	Status bool `json:"status"`
}

type UpdateCheckExtensionResp

type UpdateCheckExtensionResp struct {
	NewVersion string `json:"newVersion"`
}

type UpdateExtensionSettings

type UpdateExtensionSettings struct {
	Settings map[string]any `json:"settings"`
}

type WebBasicAuth

type WebBasicAuth struct {
	Username string
	Password string
}

func (*WebBasicAuth) Authorization

func (cfg *WebBasicAuth) Authorization() string

Authorization returns the value of the Authorization header to be used in HTTP requests.