model

package

v1.3.5 Latest Latest Go to latest Published: Jul 7, 2023 License: GPL-3.0 Imports: 2 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/GopeedLab/gopeed

Links

Open Source Insights

Documentation ¶

Index ¶

type Command
type CreateTask
type RespCode
type Result
type StartConfig
- func (cfg *StartConfig) Init() *StartConfig
type Storage

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Command ¶

type Command struct {
	Protocol string `json:"protocol"`
	Action   string `json:"action"`
	Params   any    `json:"params"`
}

type CreateTask ¶

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

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"`
	ApiToken        string  `json:"apiToken"`

	WebEnable bool
	WebFS     fs.FS
}

func (*StartConfig) Init ¶

func (cfg *StartConfig) Init() *StartConfig

type Storage ¶

type Storage string

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL