image

Documentation

Index

• Variables
• type Image
• type ImageInfo
  • func NewImageInfo(img Image) *ImageInfo
• type OpenWithType
• type Type

Variables

var ErrWrongType = errors.New("wrong image type")

ErrWrongType is returned from [Opener].

Types

type Image

type Image interface {
	io.ReaderAt
	io.Closer
	Type() Type
	Size() int64 // -1 if unknown
	Readable() error
}

Image implements io.ReaderAt and io.Closer.

type ImageInfo

type ImageInfo struct {
	Type  Type  `json:"type"`
	Size  int64 `json:"size"`
	Image `json:"image"`
}

ImageInfo wraps Image for [json.Marshal].

func NewImageInfo

func NewImageInfo(img Image) *ImageInfo

NewImageInfo returns image info.

type OpenWithType

type OpenWithType func(io.ReaderAt, Type) (Image, error)

OpenWithType opens Image with the specified Type. Opener must return ErrWrongType when the image is not parsable with the specified Type.

type Type

type Type string

Type must be a "Backing file format name string" that appears in QCOW2.