source

Documentation

Overview

Package source resolves image sources: file paths, data URIs, and remote URLs.

Index

• Constants
• type Kind
• type Resolved
  • func Resolve(ctx context.Context, src string) (*Resolved, error)

Constants

const MaxRemoteBytes = 64 * 1024 * 1024

MaxRemoteBytes caps remote/data URI payloads to prevent OOM on hostile servers.

Types

type Kind

type Kind int

Kind tags how the source should be loaded.

const (
	KindFile Kind = iota
	KindBytes
)

type Resolved

type Resolved struct {
	Kind  Kind
	Path  string // when Kind == KindFile
	Bytes []byte // when Kind == KindBytes
}

Resolved is the resolver result. Exactly one of Path or Bytes is set.

func Resolve

func Resolve(ctx context.Context, src string) (*Resolved, error)

Resolve inspects src and returns either a file path or pre-loaded bytes. HTTP(S) URLs and data: URIs are fetched/decoded here; everything else is treated as a file path.