scaler

Documentation

Overview

Package scaler provides utilities for scaling images.

Index

• Variables
• type Result
• type Scaler
  • func New(ctx context.Context) Scaler

Variables

var ErrCancelled = fmt.Errorf("scale operation on cancelled Scaler")

ErrCancelled is returned when one is trying to interact with an stopped scaler.

Types

type Result

type Result struct {
	ImgData []byte
	Err     error
}

Result is a type which encapsulates a result from an image conversion.

type Scaler

type Scaler interface {
	// Scale converts the image (img) to have width toWidth in pixels while
	// preserving its aspect ratio.
	Scale(ctx context.Context, img io.Reader, toWidth int) ([]byte, error)

	// Cancel stops the scaler and of its operations. Users may not use
	// any further methods on cancelled scalers.
	Cancel()
}

Scaler is a utility type which could be used for scaling images.

func New

func New(ctx context.Context) Scaler

New returns a new scaler, ready for use.