core

Documentation

Index

• Constants
• Variables
• func CreateETagFromFile(filePath string) (string, error)
• func DetermineImageType(imagePath string) (vips.ImageType, error)
• func DoesFileExist(filePath string) (bool, error)
• func ReadWholeFile(filePath string) ([]byte, error)
• type JobLimiter
  • func NewJobLimiter(max uint) *JobLimiter
  • func (jc *JobLimiter) AddJob() error
  • func (jc *JobLimiter) Jobs() uint
  • func (jc *JobLimiter) RemoveJob()
• type NonStandardSupport
  • func NonStandardFromAcceptHeader(headerContent string) NonStandardSupport
• type OptimiseJob
  • func (job *OptimiseJob) Optimise() ([]byte, error)

Constants

const AppName = "Img Opt"

Variables

var ErrJobLimitReached = errors.New("Job Limit Has Been Reached")

var FormatNameToImageType = map[string]vips.ImageType{
	"jpeg": vips.ImageTypeJPEG,
	"png":  vips.ImageTypePNG,
	"webp": vips.ImageTypeWEBP,
	"avif": vips.ImageTypeAVIF,
}

var ImageTypeToFormatName = map[vips.ImageType]string{
	vips.ImageTypeJPEG: "jpeg",
	vips.ImageTypePNG:  "png",
	vips.ImageTypeWEBP: "webp",
	vips.ImageTypeAVIF: "avif",
}

var ImageTypeToMime = map[vips.ImageType]string{
	vips.ImageTypeJPEG: "image/jpeg",
	vips.ImageTypePNG:  "image/png",
	vips.ImageTypeWEBP: "image/webp",
	vips.ImageTypeAVIF: "image/avif",
}

var UnknownImageTypeErr = errors.New("unknown image type")

var UnsupportedImageTypeErr = errors.New("unsupported image type")

Functions

func CreateETagFromFile

func CreateETagFromFile(filePath string) (string, error)

func DetermineImageType

func DetermineImageType(imagePath string) (vips.ImageType, error)

func DoesFileExist

func DoesFileExist(filePath string) (bool, error)

func ReadWholeFile

func ReadWholeFile(filePath string) ([]byte, error)

Types

type JobLimiter

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

func NewJobLimiter

func NewJobLimiter(max uint) *JobLimiter

func (*JobLimiter) AddJob

func (jc *JobLimiter) AddJob() error

func (*JobLimiter) Jobs

func (jc *JobLimiter) Jobs() uint

func (*JobLimiter) RemoveJob

func (jc *JobLimiter) RemoveJob()

type NonStandardSupport

type NonStandardSupport struct {
	WEBP bool
	AVIF bool
}

func NonStandardFromAcceptHeader

func NonStandardFromAcceptHeader(headerContent string) NonStandardSupport

type OptimiseJob

type OptimiseJob struct {
	FullPath string
	OutType  vips.ImageType
	MaxWidth *int
	Quality  int
}

func (*OptimiseJob) Optimise

func (job *OptimiseJob) Optimise() ([]byte, error)