stashbox

Documentation

Index

• type Client
  • func NewClient(box models.StashBox, txnManager txn.Manager, repo Repository) *Client
  • func (c Client) FindStashBoxPerformerByID(ctx context.Context, id string) (*models.ScrapedPerformer, error)
  • func (c Client) FindStashBoxPerformerByName(ctx context.Context, name string) (*models.ScrapedPerformer, error)
  • func (c Client) FindStashBoxPerformersByNames(ctx context.Context, performerIDs []string) ([]*StashBoxPerformerQueryResult, error)
  • func (c Client) FindStashBoxPerformersByPerformerNames(ctx context.Context, performerIDs []string) ([][]*models.ScrapedPerformer, error)
  • func (c Client) FindStashBoxSceneByFingerprints(ctx context.Context, sceneID int) ([]*scraper.ScrapedScene, error)
  • func (c Client) FindStashBoxScenesByFingerprints(ctx context.Context, ids []int) ([][]*scraper.ScrapedScene, error)
  • func (c Client) GetUser(ctx context.Context) (*graphql.Me, error)
  • func (c Client) QueryStashBoxPerformer(ctx context.Context, queryStr string) ([]*StashBoxPerformerQueryResult, error)
  • func (c Client) QueryStashBoxScene(ctx context.Context, queryStr string) ([]*scraper.ScrapedScene, error)
  • func (c Client) SubmitPerformerDraft(ctx context.Context, performer *models.Performer, endpoint string) (*string, error)
  • func (c Client) SubmitSceneDraft(ctx context.Context, scene *models.Scene, endpoint string, imagePath string) (*string, error)
  • func (c Client) SubmitStashBoxFingerprints(ctx context.Context, sceneIDs []string, endpoint string) (bool, error)
• type PerformerReader
• type Repository
• type SceneReader
• type StashBoxPerformerQueryResult
• type StudioReader
• type TagFinder

Types

type Client

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

Client represents the client interface to a stash-box server instance.

func NewClient

func NewClient(box models.StashBox, txnManager txn.Manager, repo Repository) *Client

NewClient returns a new instance of a stash-box client.

func (Client) FindStashBoxPerformerByID

func (c Client) FindStashBoxPerformerByID(ctx context.Context, id string) (*models.ScrapedPerformer, error)

func (Client) FindStashBoxPerformerByName

func (c Client) FindStashBoxPerformerByName(ctx context.Context, name string) (*models.ScrapedPerformer, error)

func (Client) FindStashBoxPerformersByNames

func (c Client) FindStashBoxPerformersByNames(ctx context.Context, performerIDs []string) ([]*StashBoxPerformerQueryResult, error)

FindStashBoxPerformersByNames queries stash-box for performers by name

func (Client) FindStashBoxPerformersByPerformerNames

func (c Client) FindStashBoxPerformersByPerformerNames(ctx context.Context, performerIDs []string) ([][]*models.ScrapedPerformer, error)

func (Client) FindStashBoxSceneByFingerprints

func (c Client) FindStashBoxSceneByFingerprints(ctx context.Context, sceneID int) ([]*scraper.ScrapedScene, error)

FindStashBoxScenesByFingerprints queries stash-box for a scene using the scene's MD5/OSHASH checksum, or PHash.

func (Client) FindStashBoxScenesByFingerprints

func (c Client) FindStashBoxScenesByFingerprints(ctx context.Context, ids []int) ([][]*scraper.ScrapedScene, error)

FindStashBoxScenesByFingerprints queries stash-box for scenes using every scene's MD5/OSHASH checksum, or PHash, and returns results in the same order as the input slice.

func (Client) GetUser

func (c Client) GetUser(ctx context.Context) (*graphql.Me, error)

func (Client) QueryStashBoxPerformer

func (c Client) QueryStashBoxPerformer(ctx context.Context, queryStr string) ([]*StashBoxPerformerQueryResult, error)

QueryStashBoxPerformer queries stash-box for performers using a query string.

func (Client) QueryStashBoxScene

func (c Client) QueryStashBoxScene(ctx context.Context, queryStr string) ([]*scraper.ScrapedScene, error)

QueryStashBoxScene queries stash-box for scenes using a query string.

func (Client) SubmitPerformerDraft

func (c Client) SubmitPerformerDraft(ctx context.Context, performer *models.Performer, endpoint string) (*string, error)

func (Client) SubmitSceneDraft

func (c Client) SubmitSceneDraft(ctx context.Context, scene *models.Scene, endpoint string, imagePath string) (*string, error)

func (Client) SubmitStashBoxFingerprints

func (c Client) SubmitStashBoxFingerprints(ctx context.Context, sceneIDs []string, endpoint string) (bool, error)

type PerformerReader

type PerformerReader interface {
	match.PerformerFinder
	Find(ctx context.Context, id int) (*models.Performer, error)
	FindBySceneID(ctx context.Context, sceneID int) ([]*models.Performer, error)
	models.StashIDLoader
	GetImage(ctx context.Context, performerID int) ([]byte, error)
}

type Repository

type Repository struct {
	Scene     SceneReader
	Performer PerformerReader
	Tag       TagFinder
	Studio    StudioReader
}

type SceneReader

type SceneReader interface {
	Find(ctx context.Context, id int) (*models.Scene, error)
	models.StashIDLoader
	models.VideoFileLoader
}

type StashBoxPerformerQueryResult

type StashBoxPerformerQueryResult struct {
	Query   string                     `json:"query"`
	Results []*models.ScrapedPerformer `json:"results"`
}

type StudioReader

type StudioReader interface {
	match.StudioFinder
	studio.Finder
	models.StashIDLoader
}

type TagFinder

type TagFinder interface {
	tag.Queryer
	FindBySceneID(ctx context.Context, sceneID int) ([]*models.Tag, error)
}