cache

Documentation

Index

• func ClearAllCaches()
• func ClearFieldCache()
• func ClearReferenceCache()
• func ClearURLCache()
• type CacheStats
  • func GetAllCacheStats() CacheStats
• type Manager

Examples

• ClearAllCaches
• ClearURLCache
• GetAllCacheStats

Functions

func ClearAllCaches

func ClearAllCaches()

ClearAllCaches clears all global caches in the system. This includes: - URL parsing cache (internal/utils) - Reference resolution cache (references) - Field mapping cache (marshaller)

This function is thread-safe and can be called from multiple goroutines. It's particularly useful for: - Testing scenarios where clean state is needed - Memory management when caches are no longer needed - Development/debugging when cache invalidation is required

Example

ExampleClearAllCaches demonstrates how to clear all global caches

package main

import (
	"fmt"

	"github.com/speakeasy-api/openapi/cache"
	"github.com/speakeasy-api/openapi/internal/utils"
	"github.com/speakeasy-api/openapi/references"
)

func main() {
	// Start with clean caches for predictable output
	cache.ClearAllCaches()

	// Use some cached operations to populate caches
	_, _ = utils.ParseURLCached("https://example.com/api")
	_, _ = references.ResolveAbsoluteReferenceCached(
		references.Reference("#/components/schemas/User"),
		"https://api.example.com/openapi.yaml",
	)

	// Check cache stats before clearing
	stats := cache.GetAllCacheStats()
	fmt.Printf("Before clearing - URL cache: %d, Reference cache: %d, Field cache: %d\n",
		stats.URLCacheSize, stats.ReferenceCacheSize, stats.FieldCacheSize)

	// Clear all caches at once
	cache.ClearAllCaches()

	// Check cache stats after clearing
	stats = cache.GetAllCacheStats()
	fmt.Printf("After clearing - URL cache: %d, Reference cache: %d, Field cache: %d\n",
		stats.URLCacheSize, stats.ReferenceCacheSize, stats.FieldCacheSize)

}

Output:

Before clearing - URL cache: 2, Reference cache: 1, Field cache: 0
After clearing - URL cache: 0, Reference cache: 0, Field cache: 0

func ClearFieldCache

func ClearFieldCache()

ClearFieldCache clears the global field mapping cache. This cache stores pre-computed field maps for struct types to avoid expensive reflection operations during unmarshalling.

func ClearReferenceCache

func ClearReferenceCache()

ClearReferenceCache clears the global reference resolution cache. This cache stores resolved reference results to avoid repeated resolution of the same (reference, target) pairs.

func ClearURLCache

func ClearURLCache()

ClearURLCache clears the global URL parsing cache. This cache stores parsed URL objects to avoid repeated parsing of the same URLs.

Example

ExampleClearURLCache demonstrates how to clear only the URL cache

package main

import (
	"fmt"

	"github.com/speakeasy-api/openapi/cache"
	"github.com/speakeasy-api/openapi/internal/utils"
)

func main() {
	// Populate URL cache
	_, _ = utils.ParseURLCached("https://example.com/api/v1")
	_, _ = utils.ParseURLCached("https://example.com/api/v2")

	// Check URL cache size
	stats := cache.GetAllCacheStats()
	fmt.Printf("URL cache size before clearing: %d\n", stats.URLCacheSize)

	// Clear only URL cache
	cache.ClearURLCache()

	// Check URL cache size after clearing
	stats = cache.GetAllCacheStats()
	fmt.Printf("URL cache size after clearing: %d\n", stats.URLCacheSize)

}

Output:

URL cache size before clearing: 2
URL cache size after clearing: 0

Types

type CacheStats

type CacheStats struct {
	URLCacheSize       int64
	ReferenceCacheSize int64
	FieldCacheSize     int64
}

GetCacheStats returns statistics about all global caches

func GetAllCacheStats

func GetAllCacheStats() CacheStats

GetAllCacheStats returns statistics about all global caches in the system

Example

ExampleGetAllCacheStats demonstrates how to get statistics about all caches

package main

import (
	"fmt"

	"github.com/speakeasy-api/openapi/cache"
	"github.com/speakeasy-api/openapi/internal/utils"
	"github.com/speakeasy-api/openapi/references"
)

func main() {
	// Clear all caches first for consistent output
	cache.ClearAllCaches()

	// Populate some caches
	_, _ = utils.ParseURLCached("https://example.com/api")
	_, _ = references.ResolveAbsoluteReferenceCached(
		references.Reference("#/components/schemas/User"),
		"https://api.example.com/openapi.yaml",
	)

	// Get cache statistics
	stats := cache.GetAllCacheStats()
	fmt.Printf("Cache Statistics:\n")
	fmt.Printf("  URL Cache: %d entries\n", stats.URLCacheSize)
	fmt.Printf("  Reference Cache: %d entries\n", stats.ReferenceCacheSize)
	fmt.Printf("  Field Cache: %d entries\n", stats.FieldCacheSize)

}

Output:

Cache Statistics:
  URL Cache: 2 entries
  Reference Cache: 1 entries
  Field Cache: 0 entries

type Manager

type Manager struct{}

Manager provides centralized cache management for all global caches in the system