converter

Documentation

Index

• type ConversionResult
• type ConvertOptions
• type ImageConverter
  • func NewImageConverter(options ConvertOptions) *ImageConverter
  • func (ic *ImageConverter) Convert(path string, format string) *ConversionResult
  • func (ic *ImageConverter) ConvertWithOutputPath(path string, format string, outputPath string) *ConversionResult

Types

type ConversionResult

type ConversionResult struct {
	OriginalPath string
	NewPath      string
	OriginalSize int64
	NewSize      int64
	Duration     time.Duration
	Error        error
}

ConversionResult holds the outcome of a single image conversion.

type ConvertOptions

type ConvertOptions struct {
	Quality      uint16
	MaxDimension uint16
	KeepOriginal bool
	DryRun       bool
	Backup       bool
}

ConvertOptions contains the settings for the image conversion process.

type ImageConverter

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

ImageConverter is responsible for converting images.

func NewImageConverter

func NewImageConverter(options ConvertOptions) *ImageConverter

NewImageConverter returns a new ImageConverter instance.

func (*ImageConverter) Convert

func (ic *ImageConverter) Convert(path string, format string) *ConversionResult

Convert converts the image at the given path to the given format.

func (*ImageConverter) ConvertWithOutputPath

func (ic *ImageConverter) ConvertWithOutputPath(path string, format string, outputPath string) *ConversionResult

ConvertWithOutputPath converts the image at the given path to the given format with a custom output path.