img

Documentation

Index

• Variables
• type Format
  • func ParseFormat(name string) (Format, error)
  • func (x Format) MarshalText() ([]byte, error)
  • func (x *Format) Scan(value interface{}) error
  • func (x Format) String() string
  • func (x *Format) UnmarshalText(text []byte) error
  • func (x Format) Value() (driver.Value, error)
• type Option
  • func WithFormat(format Format) Option
  • func WithMode(mode ResizeMode) Option
  • func WithQuality(quality Quality) Option
• type Quality
  • func ParseQuality(name string) (Quality, error)
  • func (x Quality) MarshalText() ([]byte, error)
  • func (x *Quality) Scan(value interface{}) error
  • func (x Quality) String() string
  • func (x *Quality) UnmarshalText(text []byte) error
  • func (x Quality) Value() (driver.Value, error)
• type ResizeMode
  • func ParseResizeMode(name string) (ResizeMode, error)
  • func (x ResizeMode) MarshalText() ([]byte, error)
  • func (x *ResizeMode) Scan(value interface{}) error
  • func (x ResizeMode) String() string
  • func (x *ResizeMode) UnmarshalText(text []byte) error
  • func (x ResizeMode) Value() (driver.Value, error)
• type Service
  • func New(workers int) *Service
  • func (s *Service) FormatFromExtension(ext string) (Format, error)
  • func (s *Service) Resize(ctx context.Context, in io.Reader, width, height int, out io.Writer, ...) error

Variables

var ErrUnsupportedFormat = errors.New("unsupported image format")

ErrUnsupportedFormat means the given image format is not supported.

Types

type Format

type Format int

Format is an image file format.

ENUM( jpeg png gif tiff bmp )

const (
	// FormatJpeg is a Format of type Jpeg
	FormatJpeg Format = iota
	// FormatPng is a Format of type Png
	FormatPng
	// FormatGif is a Format of type Gif
	FormatGif
	// FormatTiff is a Format of type Tiff
	FormatTiff
	// FormatBmp is a Format of type Bmp
	FormatBmp
)

func ParseFormat

func ParseFormat(name string) (Format, error)

ParseFormat attempts to convert a string to a Format

func (Format) MarshalText

func (x Format) MarshalText() ([]byte, error)

MarshalText implements the text marshaller method

func (*Format) Scan

func (x *Format) Scan(value interface{}) error

Scan implements the Scanner interface.

func (Format) String

func (x Format) String() string

String implements the Stringer interface.

func (*Format) UnmarshalText

func (x *Format) UnmarshalText(text []byte) error

UnmarshalText implements the text unmarshaller method

func (Format) Value

func (x Format) Value() (driver.Value, error)

Value implements the driver Valuer interface.

type Option

type Option func(*resizeConfig)

func WithFormat

func WithFormat(format Format) Option

func WithMode

func WithMode(mode ResizeMode) Option

func WithQuality

func WithQuality(quality Quality) Option

type Quality

type Quality int

ENUM( high medium low )

const (
	// QualityHigh is a Quality of type High
	QualityHigh Quality = iota
	// QualityMedium is a Quality of type Medium
	QualityMedium
	// QualityLow is a Quality of type Low
	QualityLow
)

func ParseQuality

func ParseQuality(name string) (Quality, error)

ParseQuality attempts to convert a string to a Quality

func (Quality) MarshalText

func (x Quality) MarshalText() ([]byte, error)

MarshalText implements the text marshaller method

func (*Quality) Scan

func (x *Quality) Scan(value interface{}) error

Scan implements the Scanner interface.

func (Quality) String

func (x Quality) String() string

String implements the Stringer interface.

func (*Quality) UnmarshalText

func (x *Quality) UnmarshalText(text []byte) error

UnmarshalText implements the text unmarshaller method

func (Quality) Value

func (x Quality) Value() (driver.Value, error)

Value implements the driver Valuer interface.

type ResizeMode

type ResizeMode int

ENUM( fit fill )

const (
	// ResizeModeFit is a ResizeMode of type Fit
	ResizeModeFit ResizeMode = iota
	// ResizeModeFill is a ResizeMode of type Fill
	ResizeModeFill
)

func ParseResizeMode

func ParseResizeMode(name string) (ResizeMode, error)

ParseResizeMode attempts to convert a string to a ResizeMode

func (ResizeMode) MarshalText

func (x ResizeMode) MarshalText() ([]byte, error)

MarshalText implements the text marshaller method

func (*ResizeMode) Scan

func (x *ResizeMode) Scan(value interface{}) error

Scan implements the Scanner interface.

func (ResizeMode) String

func (x ResizeMode) String() string

String implements the Stringer interface.

func (*ResizeMode) UnmarshalText

func (x *ResizeMode) UnmarshalText(text []byte) error

UnmarshalText implements the text unmarshaller method

func (ResizeMode) Value

func (x ResizeMode) Value() (driver.Value, error)

Value implements the driver Valuer interface.

type Service

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

Service

func New

func New(workers int) *Service

func (*Service) FormatFromExtension

func (s *Service) FormatFromExtension(ext string) (Format, error)

func (*Service) Resize

func (s *Service) Resize(ctx context.Context, in io.Reader, width, height int, out io.Writer, options ...Option) error