api

Documentation

Index

• Variables
• func BaseURLMiddleware(next http.Handler) http.Handler
• func GetVersion() (string, string, string)
• func IsDevelop() bool
• func SecurityHeadersMiddleware(next http.Handler) http.Handler
• func Start() error
• type CaptionFinder
• type GallerySceneGetter
• type GallerySceneUpdater
• type ImageFinder
• type LatestRelease
  • func GetLatestRelease(ctx context.Context) (*LatestRelease, error)
• type MovieFinder
• type PerformerFinder
• type Resolver
  • func (r *Resolver) Gallery() GalleryResolver
  • func (r *Resolver) GalleryChapter() GalleryChapterResolver
  • func (r *Resolver) Image() ImageResolver
  • func (r *Resolver) Movie() MovieResolver
  • func (r *Resolver) Mutation() MutationResolver
  • func (r *Resolver) Performer() PerformerResolver
  • func (r *Resolver) Query() QueryResolver
  • func (r *Resolver) Scene() SceneResolver
  • func (r *Resolver) SceneMarker() SceneMarkerResolver
  • func (r *Resolver) Studio() StudioResolver
  • func (r *Resolver) Subscription() SubscriptionResolver
  • func (r *Resolver) Tag() TagResolver
• type SceneFinder
• type SceneMarkerFinder
• type StudioFinder
• type TagFinder

Variables

var (
	// ErrNotImplemented is an error which means the given functionality isn't implemented by the API.
	ErrNotImplemented = errors.New("not implemented")

	// ErrNotSupported is returned whenever there's a test, which can be used to guard against the error,
	// but the given parameters aren't supported by the system.
	ErrNotSupported = errors.New("not supported")

	// ErrInput signifies errors where the input isn't valid for some reason. And no more specific error exists.
	ErrInput = errors.New("input error")
)

var (
	BaseURLCtxKey = &contextKey{"BaseURL"}
)

var ErrOverriddenConfig = errors.New("cannot set overridden value")

Functions

func BaseURLMiddleware

func BaseURLMiddleware(next http.Handler) http.Handler

func GetVersion

func GetVersion() (string, string, string)

func IsDevelop

func IsDevelop() bool

func SecurityHeadersMiddleware

func SecurityHeadersMiddleware(next http.Handler) http.Handler

func Start

func Start() error

Types

type CaptionFinder

type CaptionFinder interface {
	GetCaptions(ctx context.Context, fileID file.ID) ([]*models.VideoCaption, error)
}

type GallerySceneGetter

type GallerySceneGetter interface {
	GetSceneIDs(ctx context.Context, galleryID int) ([]int, error)
}

type GallerySceneUpdater

type GallerySceneUpdater interface {
	UpdateScenes(ctx context.Context, galleryID int, sceneIDs []int) error
}

type ImageFinder

type ImageFinder interface {
	Find(ctx context.Context, id int) (*models.Image, error)
	FindByChecksum(ctx context.Context, checksum string) ([]*models.Image, error)
}

type LatestRelease

type LatestRelease struct {
	Version   string
	Hash      string
	ShortHash string
	Date      string
	Url       string
}

func GetLatestRelease

func GetLatestRelease(ctx context.Context) (*LatestRelease, error)

GetLatestRelease gets latest release information from github API If running a build from the "master" branch, then the latest full release is used, otherwise it uses the release that is tagged with "latest_develop" which is the latest pre-release build.

type MovieFinder

type MovieFinder interface {
	GetFrontImage(ctx context.Context, movieID int) ([]byte, error)
	GetBackImage(ctx context.Context, movieID int) ([]byte, error)
	Find(ctx context.Context, id int) (*models.Movie, error)
}

type PerformerFinder

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

type Resolver

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

func (*Resolver) Gallery

func (r *Resolver) Gallery() GalleryResolver

func (*Resolver) GalleryChapter

func (r *Resolver) GalleryChapter() GalleryChapterResolver

func (*Resolver) Image

func (r *Resolver) Image() ImageResolver

func (*Resolver) Movie

func (r *Resolver) Movie() MovieResolver

func (*Resolver) Mutation

func (r *Resolver) Mutation() MutationResolver

func (*Resolver) Performer

func (r *Resolver) Performer() PerformerResolver

func (*Resolver) Query

func (r *Resolver) Query() QueryResolver

func (*Resolver) Scene

func (r *Resolver) Scene() SceneResolver

func (*Resolver) SceneMarker

func (r *Resolver) SceneMarker() SceneMarkerResolver

func (*Resolver) Studio

func (r *Resolver) Studio() StudioResolver

func (*Resolver) Subscription

func (r *Resolver) Subscription() SubscriptionResolver

func (*Resolver) Tag

func (r *Resolver) Tag() TagResolver

type SceneFinder

type SceneFinder interface {
	manager.SceneCoverGetter

	scene.IDFinder
	FindByChecksum(ctx context.Context, checksum string) ([]*models.Scene, error)
	FindByOSHash(ctx context.Context, oshash string) ([]*models.Scene, error)
}

type SceneMarkerFinder

type SceneMarkerFinder interface {
	Find(ctx context.Context, id int) (*models.SceneMarker, error)
	FindBySceneID(ctx context.Context, sceneID int) ([]*models.SceneMarker, error)
}

type StudioFinder

type StudioFinder interface {
	studio.Finder
	GetImage(ctx context.Context, studioID int) ([]byte, error)
}

type TagFinder

type TagFinder interface {
	tag.Finder
	GetImage(ctx context.Context, tagID int) ([]byte, error)
}