package imageasset

Import Path
	github.com/pancsta/d2/lib/imageasset (on go.dev)

Dependency Relation
	imports 33 packages, and imported by 2 packages

Involved Source Files

	  d imageasset.go
		Package imageasset resolves bounded local, HTTP, and data-URI image
		resources without depending on a renderer or scene representation. Animated
		GIF, APNG, and WebP resources use their first frame on the logical canvas;
		later frames are neither decoded nor charged to the decoded-pixel budget.

	    probe.go
	    resolve.go
Package-Level Type Names (total 9)

	/* sort by: alphabet | popularity */
	 type Cache (interface)
		Cache is optional. Implementations must be safe for concurrent use. Only
		Resources produced by this package can contain non-empty immutable data.

		Methods (total 2)
			( Cache) Get(key string) (*Resource, bool)
			( Cache) Put(key string, resource *Resource)
		Implemented By (at least one exported)
			*MemoryCache

	 type Kind uint8 (basic type)
		Kind identifies how a resolved resource must be consumed.

		Methods (only one)
			( Kind) String() string
		Implements (at least 2)
			 Kind : expvar.Var
			 Kind : fmt.Stringer
		As Outputs Of (at least one exported)
			func (*Resource).Kind() Kind
		As Types Of (total 2)
			const KindRaster
			const KindSVG

	 type LimitError (struct)
		LimitError reports the exact inclusive ceiling that was exceeded.

		Fields (total 3)
			Actual int64
			Limit int64
			Name string
		Methods (only one)
			(*LimitError) Error() string
		Implements (at least one exported)
			*LimitError : error

	 type Limits (struct)
		Limits are caller-selected, inclusive ceilings. There are intentionally no
		package defaults: callers must choose budgets appropriate to their corpus.

		Fields (total 10)
			MaxAssets int
				MaxAssets bounds distinct successfully resolved canonical sources.

			MaxCumulativeDecodedBytes int64
				MaxCumulativeDecodedBytes bounds unique canonical sources successfully
				returned by one Resolver session. Raster resources, including animated
				inputs represented by their first frame, charge at least width*height*4,
				or eight bytes per pixel for 16-bit models; SVG resources charge their
				strict raw byte length.

			MaxCumulativeEncodedBytes int64
				MaxCumulativeEncodedBytes bounds immutable encoded bytes retained by one
				Resolver session.

			MaxDecodedHeight int
			MaxDecodedPixels int64
			MaxDecodedWidth int
			MaxDecompressedBytes int64
				MaxDecompressedBytes bounds bytes after HTTP content decoding. Identity,
				local-file, and data-URI sources are checked against it as well.

			MaxEncodedBytes int64
				MaxEncodedBytes bounds the final PNG, JPEG, GIF, WebP, or SVG byte stream.

			MaxFetchedBytes int64
				MaxFetchedBytes bounds bytes read from a local file or HTTP response and
				the encoded payload text of a data URI.

			MaxSVGBytes int64
				MaxSVGBytes bounds raw or declared-compressed SVG XML before tokenization.
				Callers that import resolved SVG must align this with the importer's
				per-source byte ceiling.

		Methods (only one)
			( Limits) Validate() error

	 type MemoryCache (struct)
		MemoryCache is a bounded, concurrency-safe LRU cache. It is never installed
		globally; callers explicitly own it, and Resolver namespaces every key.

		Methods (total 2)
			(*MemoryCache) Get(key string) (*Resource, bool)
			(*MemoryCache) Put(key string, resource *Resource)
		Implements (at least one exported)
			*MemoryCache : Cache
		As Outputs Of (at least one exported)
			func NewMemoryCache(maxEntries int, maxBytes int64) (*MemoryCache, error)

	 type Options (struct)
		Options configures one independent resolver.

		Fields (total 7)
			BaseDir string
				BaseDir resolves relative local paths. New makes it absolute. When it is
				empty, rooted local-file policies use their configured root and other
				policies freeze the current working directory at construction time.

			Cache Cache
			CacheNamespace string
				CacheNamespace is required when Cache is set. Reusing a namespace asserts
				identical tenant, credentials, CookieJar, redirect policy, transport, and
				fetch semantics for every Resolver sharing that cache. NetworkPolicy is
				automatically included in the effective namespace.

			HTTPClient *http.Client
			Limits Limits
			LocalFiles localfile.Policy
				LocalFiles controls local-file access. Its zero value denies local files.
				Use localfile.Rooted for untrusted input. localfile.Unrestricted is an
				explicit opt-in intended only for trusted local applications.

			NetworkPolicy netpolicy.Policy
				NetworkPolicy defaults to public addresses only. Trusted callers can
				explicitly allow private-network assets.

		As Inputs Of (at least one exported)
			func New(options Options) (*Resolver, error)

	 type Resolver (struct)
		Resolver is one cumulative-budget session (normally one output document). It
		owns no global state and is safe for concurrent use.

		Methods (total 2)
			(*Resolver) CloseIdleConnections()
				CloseIdleConnections releases idle connections held by the transport New
				created for this resolver session. A trusted caller-injected transport is
				borrowed and remains the caller's responsibility.

			(*Resolver) Resolve(ctx context.Context, source string) (*Resource, error)
				Resolve resolves one image source and charges its decoded footprint before
				returning. Supported inputs are relative/absolute local paths, http(s) URLs,
				and data URIs. Animated GIF, APNG, and WebP resources retain their original
				bytes; native raster consumers deterministically paint the first animation
				frame on the format's logical canvas.

		As Outputs Of (at least one exported)
			func New(options Options) (*Resolver, error)

	 type Resource (struct)
		Resource is immutable after construction. BytesContext returns an owned
		copy, so a cached Resource can safely be shared between goroutines and
		converted into a scene asset without exposing the cache's backing storage.

		Methods (total 8)
			(*Resource) BytesContext(ctx context.Context) ([]byte, error)
				BytesContext returns an owned copy while observing cancellation between
				bounded chunks. A canceled copy never exposes partially initialized bytes.

			(*Resource) DataURIContext(ctx context.Context) ([]byte, error)
				DataURIContext returns a data URI for the immutable resource while observing
				cancellation between bounded encoding chunks. It encodes the resource's
				private backing bytes directly, avoiding the full owned copy required by
				BytesContext for callers that only need a self-contained representation.

			(*Resource) DecodedBytes() int64
			(*Resource) EncodedBytes() int64
			(*Resource) Kind() Kind
			(*Resource) MIMEType() string
			(*Resource) PixelHeight() int
			(*Resource) PixelWidth() int
		As Outputs Of (at least 3)
			func Cache.Get(key string) (*Resource, bool)
			func (*MemoryCache).Get(key string) (*Resource, bool)
			func (*Resolver).Resolve(ctx context.Context, source string) (*Resource, error)
		As Inputs Of (at least 2)
			func Cache.Put(key string, resource *Resource)
			func (*MemoryCache).Put(key string, resource *Resource)

	 type SourceError (struct)
		SourceError associates an error with the external source and resolution
		stage. Data URI payloads are never copied into Source or error text.

		Fields (total 3)
			Err error
			Op string
			Source string
		Methods (total 2)
			(*SourceError) Error() string
			(*SourceError) Unwrap() error
		Implements (at least 2)
			*SourceError : error
			*SourceError : golang.org/x/xerrors.Wrapper


Package-Level Functions (total 2)

	 func New(options Options) (*Resolver, error)
	 func NewMemoryCache(maxEntries int, maxBytes int64) (*MemoryCache, error)
		NewMemoryCache returns a cache with inclusive entry and encoded-byte limits.


Package-Level Variables (only one)

	  var ErrUnavailable error
		ErrUnavailable identifies a source whose bytes could not be fetched. It is
		reserved for absence and transport failures; malformed image data, policy
		limits, unsupported sources, and caller cancellation do not match it.


Package-Level Constants (total 2)

	const KindRaster Kind = 1
	const KindSVG Kind = 2

The pages are generated with Golds v0.8.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.