studio

Documentation

Index

• Variables
• func ByAlias(ctx context.Context, qb models.StudioQueryer, alias string) (*models.Studio, error)
• func ByName(ctx context.Context, qb models.StudioQueryer, name string) (*models.Studio, error)
• func EnsureAliasesUnique(ctx context.Context, id int, aliases []string, qb models.StudioQueryer) error
• func EnsureStudioNameUnique(ctx context.Context, id int, name string, qb models.StudioQueryer) error
• func ToJSON(ctx context.Context, reader FinderImageStashIDGetter, studio *models.Studio) (*jsonschema.Studio, error)
• func ValidateModify(ctx context.Context, s models.StudioPartial, qb ValidateModifyReader) error
• type FinderImageStashIDGetter
• type Importer
  • func (i *Importer) Create(ctx context.Context) (*int, error)
  • func (i *Importer) FindExistingID(ctx context.Context) (*int, error)
  • func (i *Importer) Name() string
  • func (i *Importer) PostImport(ctx context.Context, id int) error
  • func (i *Importer) PreImport(ctx context.Context) error
  • func (i *Importer) Update(ctx context.Context, id int) error
• type ImporterReaderWriter
• type NameExistsError
  • func (e *NameExistsError) Error() string
• type NameUsedByAliasError
  • func (e *NameUsedByAliasError) Error() string
• type ValidateModifyReader

Variables

var ErrParentStudioNotExist = errors.New("parent studio does not exist")

var (
	ErrStudioOwnAncestor = errors.New("studio cannot be an ancestor of itself")
)

Functions

func ByAlias

func ByAlias(ctx context.Context, qb models.StudioQueryer, alias string) (*models.Studio, error)

func ByName

func ByName(ctx context.Context, qb models.StudioQueryer, name string) (*models.Studio, error)

func EnsureAliasesUnique

func EnsureAliasesUnique(ctx context.Context, id int, aliases []string, qb models.StudioQueryer) error

func EnsureStudioNameUnique

func EnsureStudioNameUnique(ctx context.Context, id int, name string, qb models.StudioQueryer) error

EnsureStudioNameUnique returns an error if the studio name provided is used as a name or alias of another existing tag.

func ToJSON

func ToJSON(ctx context.Context, reader FinderImageStashIDGetter, studio *models.Studio) (*jsonschema.Studio, error)

ToJSON converts a Studio object into its JSON equivalent.

func ValidateModify

func ValidateModify(ctx context.Context, s models.StudioPartial, qb ValidateModifyReader) error

Checks to make sure that: 1. The studio exists locally 2. The studio is not its own ancestor 3. The studio's aliases are unique 4. The name is unique

Types

type FinderImageStashIDGetter

type FinderImageStashIDGetter interface {
	models.StudioGetter
	models.AliasLoader
	models.StashIDLoader
	GetImage(ctx context.Context, studioID int) ([]byte, error)
}

type Importer

type Importer struct {
	ReaderWriter        ImporterReaderWriter
	Input               jsonschema.Studio
	MissingRefBehaviour models.ImportMissingRefEnum

	ID int
	// contains filtered or unexported fields
}

func (*Importer) Create

func (i *Importer) Create(ctx context.Context) (*int, error)

func (*Importer) FindExistingID

func (i *Importer) FindExistingID(ctx context.Context) (*int, error)

func (*Importer) Name

func (i *Importer) Name() string

func (*Importer) PostImport

func (i *Importer) PostImport(ctx context.Context, id int) error

func (*Importer) PreImport

func (i *Importer) PreImport(ctx context.Context) error

func (*Importer) Update

func (i *Importer) Update(ctx context.Context, id int) error

type ImporterReaderWriter

type ImporterReaderWriter interface {
	models.StudioCreatorUpdater
	FindByName(ctx context.Context, name string, nocase bool) (*models.Studio, error)
}

type NameExistsError

type NameExistsError struct {
	Name string
}

func (*NameExistsError) Error

func (e *NameExistsError) Error() string

type NameUsedByAliasError

type NameUsedByAliasError struct {
	Name        string
	OtherStudio string
}

func (*NameUsedByAliasError) Error

func (e *NameUsedByAliasError) Error() string

type ValidateModifyReader

type ValidateModifyReader interface {
	models.StudioGetter
	models.StudioQueryer
	models.AliasLoader
}