# Packages
Package json provides generic JSON types.
Package jsonschema provides the JSON schema models used for importing and exporting data.
Package mocks provides mocks for various interfaces in [models].
Package paths provides functions to return paths to various resources.
# Functions
BatchFindFilter returns a FindFilterType suitable for batch finding using the provided batch size.
NewOptionalBool returns a new OptionalBool with the given value.
NewOptionalBoolPtr returns a new OptionalBool with the given value.
NewOptionalDate returns a new OptionalDate with the given value.
NewOptionalBoolPtr returns a new OptionalDate with the given value.
NewOptionalFloat64 returns a new OptionalFloat64 with the given value.
NewOptionalFloat64 returns a new OptionalFloat64 with the given value.
NewOptionalInt returns a new OptionalInt with the given value.
NewOptionalInt64 returns a new OptionalInt64 with the given value.
NewOptionalInt64Ptr returns a new OptionalInt64 with the given value.
NewOptionalIntPtr returns a new OptionalInt with the given value.
NewOptionalString returns a new OptionalString with the given value.
NewOptionalStringPtr returns a new OptionalString with the given value.
NewOptionalTime returns a new OptionalTime with the given value.
NewOptionalTimePtr returns a new OptionalTime with the given value.
NewRelatedGroups returns a loaded RelateGroups object with the provided groups.
NewRelatedGroups returns a loaded RelateGroups object with the provided groups.
NewRelatedIDs returns a loaded RelatedIDs object with the provided IDs.
NewRelatedStashIDs returns a RelatedStashIDs object with the provided ids.
NewRelatedStrings returns a loaded RelatedStrings object with the provided values.
ParseDate uses utils.ParseDateStringAsTime to parse a string into a date.
ParseSearchString parses the Q value and returns a SearchSpecs object.
Rating100To5 converts a 1-100 rating to a 1-5 rating.
Rating5To100 converts a 1-5 rating to a 1-100 rating.
# Constants
>= AND <=.
=.
>.
INCLUDES ALL.
IS NULL.
<.
MATCHES REGEX.
< OR >.
!=.
NOT MATCHES REGEX.
IS NOT NULL.
oshash.
PerPageAll is the value used for perPage to indicate all results should be returned.
X264_FAST.
X264_MEDIUM.
X264_SLOW.
X264_SLOWER.
X264_ULTRAFAST.
X264_VERYFAST.
X264_VERYSLOW.
8k.
5k.
4k.
1080p.
8K+.
240p.
1440p.
360p.
7k.
6k.
480p.
720p.
144p.
1920p - deprecated.
540p.
4k.
1080p.
240p.
Original.
480p.
720p.
TenStar = "TenStar" TenPointFiveStar = "TenPointFiveStar" TenPointTwoFiveStar = "TenPointTwoFiveStar".
# Variables
ErrConversion signifies conversion errors.
ErrNotFound signifies entities which are not found.
# Structs
BaseFile represents a file in the file system.
Date wraps a time.Time with a format of "YYYY-MM-DD".
DirEntry represents a file or directory in the file system.
Fingerprint represents a fingerprint of a file.
Folder represents a folder in the file system.
GalleryChapterPartial represents part of a GalleryChapter object.
GalleryPartial represents part of a Gallery object.
Image stores the metadata for a single image.
ImageFile is an extension of BaseFile to represent image files.
OptionalBool represents an optional int64 argument that may be null.
OptionalDate represents an optional date argument that may be null.
OptionalFloat64 represents an optional float64 argument that may be null.
OptionalInt represents an optional int argument that may be null.
OptionalInt64 represents an optional int64 argument that may be null.
OptionalString represents an optional string argument that may be null.
OptionalTime represents an optional time argument that may be null.
PerformerPartial represents part of a Performer object.
RelatedGroups represents a list of related Groups.
RelatedIDs represents a list of related IDs.
RelatedStrings represents a list of related strings.
Scene stores the metadata for a single video scene.
SceneFileType represents the file metadata for a scene.
SceneMarkerPartial represents part of a SceneMarker object.
SceneMovieInput is used for groups and movies.
ScenePartial represents part of a Scene object.
ScrapedGroup is a group from a scraping operation.
A movie from a scraping operation...
A performer from a scraping operation...
SearchSpecs provides the specifications for text-based searches.
StudioPartial represents part of a Studio object.
VideoFile is an extension of BaseFile to represent video files.
# Interfaces
BlobReader provides methods to get files by ID.
File represents a file in the file system.
FileCounter provides methods to count files.
FileCreator provides methods to create files.
FileDestroyer provides methods to destroy files.
FileFinder provides methods to find files.
FileGetter provides methods to get files by ID.
FileOpener provides an interface to open a file.
FileQueryer provides methods to query files.
FileReader provides all methods to read files.
FileReaderWriter provides all file methods.
FileUpdater provides methods to update files.
FileWriter provides all methods to modify files.
FolderCreator provides methods to create folders.
FolderFinder provides methods to find folders.
FolderGetter provides methods to get folders by ID.
FolderReader provides all methods to read folders.
FolderReaderWriter provides all folder methods.
FolderUpdater provides methods to update folders.
FolderWriter provides all methods to modify folders.
FS represents a file system.
GalleryChapterCreator provides methods to create gallery chapters.
GalleryChapterDestroyer provides methods to destroy gallery chapters.
GalleryChapterFinder provides methods to find gallery chapters.
GalleryChapterGetter provides methods to get gallery chapters by ID.
GalleryChapterReader provides all methods to read gallery chapters.
GalleryChapterReaderWriter provides all gallery chapter methods.
GalleryChapterUpdater provides methods to update gallery chapters.
GalleryChapterWriter provides all methods to modify gallery chapters.
GalleryCounter provides methods to count galleries.
GalleryCreator provides methods to create galleries.
GalleryDestroyer provides methods to destroy galleries.
GalleryFinder provides methods to find galleries.
GalleryGetter provides methods to get galleries by ID.
GalleryQueryer provides methods to query galleries.
GalleryReader provides all methods to read galleries.
GalleryReaderWriter provides all gallery methods.
GalleryUpdater provides methods to update galleries.
GalleryWriter provides all methods to modify galleries.
GroupCounter provides methods to count groups.
GroupCreator provides methods to create groups.
GroupDestroyer provides methods to destroy groups.
GroupFinder provides methods to find groups.
GroupGetter provides methods to get groups by ID.
GroupQueryer provides methods to query groups.
GroupReader provides all methods to read groups.
GroupReaderWriter provides all group methods.
GroupUpdater provides methods to update groups.
GroupWriter provides all methods to modify groups.
ImageCounter provides methods to count images.
ImageCreator provides methods to create images.
ImageDestroyer provides methods to destroy images.
ImageFinder provides methods to find images.
ImageGetter provides methods to get images by ID.
ImageQueryer provides methods to query images.
ImageReader provides all methods to read images.
ImageReaderWriter provides all image methods.
ImageUpdater provides methods to update images.
ImageWriter provides all methods to modify images.
PerformerCounter provides methods to count performers.
PerformerCreator provides methods to create performers.
PerformerDestroyer provides methods to destroy performers.
PerformerFinder provides methods to find performers.
PerformerGetter provides methods to get performers by ID.
PerformerQueryer provides methods to query performers.
PerformerReader provides all methods to read performers.
PerformerReaderWriter provides all performer methods.
PerformerUpdater provides methods to update performers.
PerformerWriter provides all methods to modify performers.
SceneCounter provides methods to count scenes.
SceneCreator provides methods to create scenes.
SceneDestroyer provides methods to destroy scenes.
SceneFinder provides methods to find scenes.
SceneGetter provides methods to get scenes by ID.
SceneMarkerCounter provides methods to count scene markers.
SceneMarkerCreator provides methods to create scene markers.
SceneMarkerDestroyer provides methods to destroy scene markers.
SceneMarkerFinder provides methods to find scene markers.
SceneMarkerGetter provides methods to get scene markers by ID.
SceneMarkerQueryer provides methods to query scene markers.
SceneMarkerReader provides all methods to read scene markers.
SceneMarkerReaderWriter provides all scene marker methods.
SceneMarkerUpdater provides methods to update scene markers.
SceneMarkerWriter provides all methods to modify scene markers.
SceneQueryer provides methods to query scenes.
SceneReader provides all methods to read scenes.
SceneReaderWriter provides all scene methods.
SceneUpdater provides methods to update scenes.
SceneWriter provides all methods to modify scenes.
StudioCounter provides methods to count studios.
StudioCreator provides methods to create studios.
StudioDestroyer provides methods to destroy studios.
StudioFinder provides methods to find studios.
StudioGetter provides methods to get studios by ID.
StudioQueryer provides methods to query studios.
StudioReader provides all methods to read studios.
StudioReaderWriter provides all studio methods.
StudioUpdater provides methods to update studios.
StudioWriter provides all methods to modify studios.
TagCounter provides methods to count tags.
TagCreator provides methods to create tags.
TagDestroyer provides methods to destroy tags.
TagFinder provides methods to find tags.
TagGetter provides methods to get tags by ID.
TagQueryer provides methods to query tags.
TagReader provides all methods to read tags.
TagReaderWriter provides all tags methods.
TagUpdater provides methods to update tags.
TagWriter provides all methods to modify tags.
VisualFile is an interface for files that have a width and height.
ZipFS represents a zip file system.
# Type aliases
ID represents an ID of a file.
FolderID represents an ID of a folder.