asset

Documentation

Index

• Constants
• Variables
• func CheckKind(kind string) error
• func CheckVariant(variant string) error
• func NewRepo(db *bun.DB, conf *config.Config) (*repo, error)
• func RegisterController(v0 *server.V0, c *Controller)
• func SortAsset(query *bun.SelectQuery) *bun.SelectQuery
• func SortAssetVariant(query *bun.SelectQuery) *bun.SelectQuery
• func SortVariant(query *bun.SelectQuery) *bun.SelectQuery
• type Asset
  • func (a Asset) String() string
• type Controller
  • func NewController(service *Service) *Controller
  • func (c *Controller) GetAsset(ctx *fiber.Ctx) error
  • func (c *Controller) GetAssets(ctx *fiber.Ctx) error
  • func (c *Controller) GetKindNames(ctx *fiber.Ctx) error
  • func (c *Controller) GetVariant(ctx *fiber.Ctx) error
  • func (c *Controller) GetVariantFile(ctx *fiber.Ctx) error
  • func (c *Controller) GetVariantNames(ctx *fiber.Ctx) error
  • func (c *Controller) GetVariants(ctx *fiber.Ctx) error
  • func (c *Controller) PostVariant(ctx *fiber.Ctx) error
• type Service
  • func NewService(conf *config.Config, assetRepo *repo) *Service
  • func (s *Service) GetAsset(ctx context.Context, kind, name string) (*Asset, error)
  • func (s *Service) GetAssets(ctx context.Context, kind string) ([]Asset, error)
  • func (s *Service) GetKindNames(ctx context.Context) ([]string, error)
  • func (s *Service) GetVariant(ctx context.Context, kind string, name string, variant string) (*Variant, error)
  • func (s *Service) GetVariantFile(ctx context.Context, kind, name, variant string) (*string, error)
  • func (s *Service) GetVariantNames(ctx context.Context) ([]string, error)
  • func (s *Service) GetVariants(ctx context.Context, kind string, name string) ([]Variant, error)
  • func (s *Service) InitNames(ctx context.Context) error
  • func (s *Service) PopulateFrom(ctx context.Context, dirPath string) error
  • func (s *Service) PostVariant(ctx context.Context, kind, name string, variant Variant, file io.Reader) error
• type Variant
  • func (v Variant) FilePath(dirPath string) string
  • func (v Variant) Path() string
  • func (v Variant) String() string

Constants

const (
	KindImages      = "images"
	KindBackgrounds = "backgrounds"
	KindCharacters  = "characters"

	VariantImg        = "img"
	VariantTimg       = "timg"
	VariantAlpha      = "alpha"
	VariantRealEsrgan = "real-esrgan"
	VariantRealCugan  = "real-cugan"
)

Variables

var (
	Kinds = []string{
		KindImages,
		KindBackgrounds,
		KindCharacters,
	}
	KindsMap = map[string]string{
		KindImages:      KindImages,
		KindBackgrounds: KindBackgrounds,
		KindCharacters:  KindCharacters,
	}
	Variants = []string{
		VariantImg,
		VariantTimg,
		VariantAlpha,
		VariantRealEsrgan,
		VariantRealCugan,
	}
	VariantsMap = map[string]string{
		VariantImg:        VariantImg,
		VariantTimg:       VariantTimg,
		VariantAlpha:      VariantAlpha,
		VariantRealEsrgan: VariantRealEsrgan,
		VariantRealCugan:  VariantRealCugan,
	}
)

var (
	ErrInvalidKind    = fmt.Errorf("invalid kind")
	ErrInvalidVariant = fmt.Errorf("invalid variant")
)

var (
	ErrExists = errors.New("asset: the asset or variant already exists.")
)

Functions

func CheckKind

func CheckKind(kind string) error

func CheckVariant

func CheckVariant(variant string) error

func NewRepo

func NewRepo(db *bun.DB, conf *config.Config) (*repo, error)

func RegisterController

func RegisterController(v0 *server.V0, c *Controller)

func SortAsset

func SortAsset(query *bun.SelectQuery) *bun.SelectQuery

func SortAssetVariant

func SortAssetVariant(query *bun.SelectQuery) *bun.SelectQuery

func SortVariant

func SortVariant(query *bun.SelectQuery) *bun.SelectQuery

Types

type Asset

type Asset struct {
	Kind     string     `json:"kind"`
	Name     string     `json:"name"`
	Variants *[]Variant `json:"variants"`
}

func (Asset) String

func (a Asset) String() string

String returns a string representation of the asset.

The string representation of assets is "{kind}/{name}". e.g., "images/20_i00", "backgrounds/21_g1_interrogat_room".

type Controller

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

func NewController

func NewController(service *Service) *Controller

func (*Controller) GetAsset

func (c *Controller) GetAsset(ctx *fiber.Ctx) error

func (*Controller) GetAssets

func (c *Controller) GetAssets(ctx *fiber.Ctx) error

func (*Controller) GetKindNames

func (c *Controller) GetKindNames(ctx *fiber.Ctx) error

func (*Controller) GetVariant

func (c *Controller) GetVariant(ctx *fiber.Ctx) error

func (*Controller) GetVariantFile

func (c *Controller) GetVariantFile(ctx *fiber.Ctx) error

func (*Controller) GetVariantNames

func (c *Controller) GetVariantNames(ctx *fiber.Ctx) error

func (*Controller) GetVariants

func (c *Controller) GetVariants(ctx *fiber.Ctx) error

func (*Controller) PostVariant

func (c *Controller) PostVariant(ctx *fiber.Ctx) error

type Service

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

func NewService

func NewService(conf *config.Config, assetRepo *repo) *Service

func (*Service) GetAsset

func (s *Service) GetAsset(ctx context.Context, kind, name string) (*Asset, error)

func (*Service) GetAssets

func (s *Service) GetAssets(ctx context.Context, kind string) ([]Asset, error)

func (*Service) GetKindNames

func (s *Service) GetKindNames(ctx context.Context) ([]string, error)

func (*Service) GetVariant

func (s *Service) GetVariant(ctx context.Context, kind string, name string, variant string) (*Variant, error)

func (*Service) GetVariantFile

func (s *Service) GetVariantFile(ctx context.Context, kind, name, variant string) (*string, error)

func (*Service) GetVariantNames

func (s *Service) GetVariantNames(ctx context.Context) ([]string, error)

func (*Service) GetVariants

func (s *Service) GetVariants(ctx context.Context, kind string, name string) ([]Variant, error)

func (*Service) InitNames

func (s *Service) InitNames(ctx context.Context) error

func (*Service) PopulateFrom

func (s *Service) PopulateFrom(ctx context.Context, dirPath string) error

func (*Service) PostVariant

func (s *Service) PostVariant(ctx context.Context, kind, name string, variant Variant, file io.Reader) error

type Variant

type Variant struct {
	Variant  string `json:"variant"`
	Filename string `json:"filename"`
	Asset    *Asset `json:"-"`
}

func (Variant) FilePath

func (v Variant) FilePath(dirPath string) string

FilePath returns the absolute path to the variant file.

This is a shortcut for filepath.Join(dir, v.Path()).

func (Variant) Path

func (v Variant) Path() string

Path returns the relative path to the variant file.

The path of assets is "{variant}/{asset.kind}/{filename}". When the program want to find an asset file in a certain directory, it will check the path relative to the directory.

func (Variant) String

func (v Variant) String() string

String returns a string representation of the variant.

The string representation of assets is "{asset}/{variant}". e.g., "images/20_i00/img", "backgrounds/21_g1_interrogat_room/timg".