package filecache

Import Path
	github.com/tetratelabs/wazero/internal/filecache (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 3 packages

Involved Source Files

	    compilationcache.go
	    file_cache.go
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Cache (interface)
		Cache allows the compiler engine to skip compilation of wasm to machine code
		where doing so is redundant for the same wasm binary and version of wazero.
		
		This augments the default in-memory cache of compiled functions, by
		decoupling it from a wazero.Runtime instance. Concretely, a runtime loses
		its cache once closed. This cache allows the runtime to rebuild its
		in-memory cache quicker, significantly reducing first-hit penalty on a hit.
		
		See New for the example implementation.

		Methods (total 3)
			( Cache) Add(key Key, content io.Reader) (err error)
				Add is called when the runtime is trying to add the new cache entry.
				The given `content` must be un-modified, and returned as-is in Get method.
				
				Note: the `content` is ensured to be safe through the validation phase applied on the Wasm binary.

			( Cache) Delete(key Key) (err error)
				Delete is called when the cache on the `key` returned by Get is no longer usable, and
				must be purged. Specifically, this is called happens when the wazero's version has been changed.
				For example, that is when there's a difference between the version of compiling wazero and the
				version of the currently used wazero.

			( Cache) Get(key Key) (content io.ReadCloser, ok bool, err error)
				Get is called when the runtime is trying to get the cached compiled functions.
				Implementations are supposed to return compiled function in io.Reader with ok=true
				if the key exists on the cache. In the case of not-found, this should return
				ok=false with err=nil. content.Close() is automatically called by
				the caller of this Get.
				
				Note: the returned content won't go through the validation pass of Wasm binary
				which is applied when the binary is compiled from scratch without cache hit.

		As Outputs Of (at least one exported)
			func New(dir string) Cache
		As Inputs Of (at least 2)
			func github.com/tetratelabs/wazero/internal/engine/interpreter.NewEngine(_ context.Context, enabledFeatures api.CoreFeatures, _ Cache) wasm.Engine
			func github.com/tetratelabs/wazero/internal/engine/wazevo.NewEngine(ctx context.Context, _ api.CoreFeatures, fc Cache) wasm.Engine

	 type Key = ([...])
		Key represents the 256-bit unique identifier assigned to each cache entry.


Package-Level Functions (only one)

	 func New(dir string) Cache
		New returns a new Cache implemented by fileCache.

The pages are generated with Golds v0.8.2. (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.