internal

package

Go to main page

Versions in this module

v0

v0.12.0

Nov 1, 2025

v0.11.0

Oct 29, 2025

v0.10.2

Jul 3, 2025

v0.10.1

Jul 1, 2025

v0.10.0

Jul 1, 2025

Changes in this version

+ var TraceIDKey contextKey

+ func TraceIDFromContext(ctx context.Context) (string, bool)

type Age

+ func (a Age) LogValue() slog.Value

type CacheStatus

+ func (s CacheStatus) LogValue() slog.Value

type Freshness

+ func (f Freshness) LogValue() slog.Value

+ type LogEntry struct

+ CacheStatus string

+ Error error

+ MiscProvider MiscProvider

+ URLKey string

+ type LogFunc func() (CacheStatus, *http.Request, LogEntry)

+ func (f LogFunc) MakeLog() (event CacheStatus, req *http.Request, cl LogEntry)

+ type LogProvider interface

+ MakeLog func() (CacheStatus, *http.Request, LogEntry)

+ type LogValueFunc func() slog.Value

+ func (f LogValueFunc) LogValue() slog.Value

+ type Logger struct

+ func NewLogger(h slog.Handler) *Logger

+ func (l *Logger) Enabled(ctx context.Context, level slog.Level) bool

+ func (l *Logger) Handler() slog.Handler

+ func (l *Logger) LogCacheBypass(msg string, req *http.Request, urlKey string, mp MiscProvider)

+ func (l *Logger) LogCacheError(msg string, err error, req *http.Request, urlKey string, mp MiscProvider)

+ func (l *Logger) LogCacheHit(req *http.Request, urlKey string, mp MiscProvider)

+ func (l *Logger) LogCacheMiss(req *http.Request, urlKey string, mp MiscProvider)

+ func (l *Logger) LogCacheRevalidated(req *http.Request, urlKey string, mp MiscProvider)

+ func (l *Logger) LogCacheStale(req *http.Request, urlKey string, mp MiscProvider)

+ func (l *Logger) LogCacheStaleIfError(req *http.Request, urlKey string, mp MiscProvider)

+ func (l *Logger) LogCacheStaleRevalidate(req *http.Request, urlKey string, mp MiscProvider)

+ func (l *Logger) With(attrs ...slog.Attr) *Logger

+ func (l *Logger) WithGroup(name string) *Logger

+ type Misc struct

+ CCReq CCRequestDirectives

+ CCResp CCResponseDirectives

+ Freshness *Freshness

+ RefIndex int

+ Refs ResponseRefs

+ Stored *Response

+ func (m Misc) LogValue() slog.Value

+ type MiscFunc func() Misc

+ func (f MiscFunc) MakeMisc() Misc

+ type MiscProvider interface

+ MakeMisc func() Misc

type Response

+ func (r Response) LogValue() slog.Value

type ResponseRef

+ func (r ResponseRef) LogValue() slog.Value

type RevalidationContext

+ func (r RevalidationContext) ToMisc(ccResp CCResponseDirectives) MiscFunc

v0.9.2

Jun 29, 2025

v0.9.1

Jun 29, 2025

Changes in this version

+ const FromCache

+ const FromCacheHeader

+ const NotFromCache

+ type CacheError struct

+ Err error

+ Message string

+ Op string

+ func (c *CacheError) Error() string

+ func (c *CacheError) LogValue() slog.Value

+ func (c *CacheError) Unwrap() error

v0.9.0

Jun 27, 2025

v0.8.1

Jun 26, 2025

v0.8.0

Jun 26, 2025

Changes in this version

+ const CacheStatusHeaderLegacy

type CacheStatus

+ Legacy string

+ Value string

v0.7.0

Jun 25, 2025

Changes in this version

+ func TrimmedCSVCanonicalSeq(s string) iter.Seq[string]

v0.6.0

Jun 24, 2025

v0.5.0

Jun 11, 2025

Changes in this version

+ func FixDateHeader(h http.Header, receivedAt time.Time) bool

+ func IsNonErrorStatus(status int) bool

+ func IsUnsafeMethod(req *http.Request) bool

+ type HeaderValueNormalizer interface

+ NormalizeHeaderValue func(field, value string) string

+ func NewHeaderValueNormalizer() HeaderValueNormalizer

+ type HeaderValueNormalizerFunc func(field, value string) string

+ func (f HeaderValueNormalizerFunc) NormalizeHeaderValue(field, value string) string

type MockCacheKeyer

+ func (m *MockCacheKeyer) URLKey(u *url.URL) string

type MockResponseCache

+ GetRefsFunc func(key string) (ResponseRefs, error)

+ SetRefsFunc func(key string, headers ResponseRefs) error

+ func (m *MockResponseCache) GetRefs(key string) (ResponseRefs, error)

+ func (m *MockResponseCache) SetRefs(key string, headers ResponseRefs) error

+ type Response struct

+ Data *http.Response

+ ID string

+ ReceivedAt time.Time

+ RequestedAt time.Time

+ func ParseResponse(data []byte, req *http.Request) (resp *Response, err error)

+ func (r *Response) DateHeader() time.Time

+ func (r *Response) ExpiresHeader() RawTime

+ func (r *Response) WriteTo(w io.Writer) (int64, error)

+ func (r Response) MarshalBinary() ([]byte, error)

type ResponseCache

+ GetRefs func(key string) (ResponseRefs, error)

+ SetRefs func(key string, entry ResponseRefs) error

+ type ResponseRef struct

+ ReceivedAt time.Time

+ ResponseID string

+ Vary string

+ VaryResolved map[string]string

+ type ResponseRefs []*ResponseRef

+ func (he ResponseRefs) ResponseIDs() iter.Seq[string]

type RevalidationContext

+ RefIndex int

+ Refs ResponseRefs

+ URLKey string

+ type URLKeyer interface

+ URLKey func(u *url.URL) string

+ func NewURLKeyer() URLKeyer

+ type URLKeyerFunc func(u *url.URL) string

+ func (f URLKeyerFunc) URLKey(u *url.URL) string

+ type VaryHeaderNormalizer interface

+ NormalizeVaryHeader func(vary string, reqHeader http.Header) iter.Seq2[string, string]

+ func NewVaryHeaderNormalizer() VaryHeaderNormalizer

+ type VaryHeaderNormalizerFunc func(vary string, reqHeader http.Header) iter.Seq2[string, string]

+ func (f VaryHeaderNormalizerFunc) NormalizeVaryHeader(vary string, reqHeader http.Header) iter.Seq2[string, string]

+ type VaryKeyer interface

+ VaryKey func(urlKey string, varyHeaders map[string]string) string

+ func NewVaryKeyer() VaryKeyer

+ type VaryKeyerFunc func(urlKey string, varyHeaders map[string]string) string

+ func (f VaryKeyerFunc) VaryKey(urlKey string, varyHeaders map[string]string) string

v0.4.0

Jun 5, 2025

Changes in this version

type CCResponseDirectives

+ func (d CCResponseDirectives) Immutable() bool

v0.3.2

Jun 5, 2025

v0.3.1

Jun 4, 2025

v0.3.0

Jun 4, 2025

v0.2.0

Jun 3, 2025

v0.1.0

Jun 2, 2025

Changes in this version

+ const CacheStatusHeader

+ func NewCacheInvalidator(cache ResponseCache, cke CacheKeyer) *cacheInvalidator

+ func NewClock() *clock

+ func NewFreshnessCalculator(clock Clock) *freshnessCalculator

+ func NewResponseCache(cache Cache) *responseCache

+ func NewStaleIfErrorPolicy(clock Clock) *staleIfErrorPolicy

+ func NewValidationResponseHandler(clock Clock, ci CacheInvalidator, ce CacheabilityEvaluator, ...) *validationResponseHandler

+ func ParseQuotedString(s string) string

+ func ParseQuotedStringE(s string) (string, error)

+ func SetAgeHeader(resp *http.Response, clock Clock, age *Age)

+ func TrimmedCSVSeq(s string) iter.Seq[string]

+ type Age struct

+ Timestamp time.Time

+ Value time.Duration

+ type CCRequestDirectives map[string]string

+ func ParseCCRequestDirectives(header http.Header) CCRequestDirectives

+ func (d CCRequestDirectives) MaxAge() (dur time.Duration, valid bool)

+ func (d CCRequestDirectives) MaxStale() (dur RawDeltaSeconds, valid bool)

+ func (d CCRequestDirectives) MinFresh() (dur time.Duration, valid bool)

+ func (d CCRequestDirectives) NoCache() bool

+ func (d CCRequestDirectives) NoStore() bool

+ func (d CCRequestDirectives) NoTransform() bool

+ func (d CCRequestDirectives) OnlyIfCached() bool

+ func (d CCRequestDirectives) StaleIfError() (dur time.Duration, valid bool)

+ type CCResponseDirectives map[string]string

+ func ParseCCResponseDirectives(header http.Header) CCResponseDirectives

+ func (d CCResponseDirectives) MaxAge() (dur time.Duration, valid bool)

+ func (d CCResponseDirectives) MaxAgePresent() bool

+ func (d CCResponseDirectives) MustRevalidate() bool

+ func (d CCResponseDirectives) MustUnderstand() bool

+ func (d CCResponseDirectives) NoCache() (fields RawCSVSeq, present bool)

+ func (d CCResponseDirectives) NoStore() bool

+ func (d CCResponseDirectives) NoTransform() bool

+ func (d CCResponseDirectives) Public() bool

+ func (d CCResponseDirectives) StaleIfError() (dur time.Duration, valid bool)

+ func (d CCResponseDirectives) StaleWhileRevalidate() (dur time.Duration, valid bool)

+ type Cache interface

+ Delete func(key string) error

+ Get func(key string) ([]byte, error)

+ Set func(key string, entry []byte) error

+ type CacheInvalidator interface

+ InvalidateCache func(reqURL *url.URL, respHeader http.Header, key string)

+ type CacheKeyer interface

+ CacheKey func(u *url.URL) string

+ func NewCacheKeyer() CacheKeyer

+ type CacheKeyerFunc func(u *url.URL) string

+ func (f CacheKeyerFunc) CacheKey(u *url.URL) string

+ type CacheStatus string

+ const CacheStatusBypass

+ const CacheStatusHit

+ const CacheStatusMiss

+ const CacheStatusRevalidated

+ const CacheStatusStale

+ func (s CacheStatus) ApplyTo(header http.Header)

+ func (s CacheStatus) String() string

+ type CacheabilityEvaluator interface

+ CanStoreResponse func(resp *http.Response, reqCC CCRequestDirectives, resCC CCResponseDirectives) bool

+ func NewCacheabilityEvaluator() CacheabilityEvaluator

+ type CacheabilityEvaluatorFunc func(resp *http.Response, reqCC CCRequestDirectives, resCC CCResponseDirectives) bool

+ func (f CacheabilityEvaluatorFunc) CanStoreResponse(resp *http.Response, reqCC CCRequestDirectives, resCC CCResponseDirectives) bool

+ type Clock interface

+ Now func() time.Time

+ Since func(t time.Time) time.Duration

+ type Entry struct

+ ReqTime time.Time

+ RespTime time.Time

+ Response *http.Response

+ func (e *Entry) MarshalBinary() ([]byte, error)

+ func (e *Entry) UnmarshalBinaryWithRequest(data []byte, req *http.Request) error

+ type Freshness struct

+ Age *Age

+ IsStale bool

+ UsefulLife time.Duration

+ type FreshnessCalculator interface

+ CalculateFreshness func(resp *Entry, reqCC CCRequestDirectives, resCC CCResponseDirectives) *Freshness

+ type HeaderKey string

+ func (h HeaderKey) Equal(h1, h2 http.Header) bool

+ func (h HeaderKey) String() string

+ type MockCache struct

+ DeleteFunc func(key string) error

+ GetFunc func(key string) ([]byte, error)

+ SetFunc func(key string, entry []byte) error

+ func (m *MockCache) Delete(key string) error

+ func (m *MockCache) Get(key string) ([]byte, error)

+ func (m *MockCache) Set(key string, entry []byte) error

+ type MockCacheInvalidator struct

+ InvalidateCacheFunc func(reqURL *url.URL, respHeader http.Header, key string)

+ func (m *MockCacheInvalidator) InvalidateCache(reqURL *url.URL, respHeader http.Header, key string)

+ type MockCacheKeyer struct

+ CacheKeyFunc func(u *url.URL) string

+ func (m *MockCacheKeyer) CacheKey(u *url.URL) string

+ type MockClock struct

+ NowResult time.Time

+ SinceResult time.Duration

+ func (m *MockClock) Now() time.Time

+ func (m *MockClock) Since(t time.Time) time.Duration

+ type MockFreshnessCalculator struct

+ CalculateFreshnessFunc func(resp *http.Response, reqCC CCRequestDirectives, resCC CCResponseDirectives) *Freshness

+ func (m *MockFreshnessCalculator) CalculateFreshness(resp *Entry, reqCC CCRequestDirectives, resCC CCResponseDirectives) *Freshness

+ type MockRequestMethodChecker struct

+ IsRequestMethodUnderstoodFunc func(req *http.Request) bool

+ func (m *MockRequestMethodChecker) IsRequestMethodUnderstood(req *http.Request) bool

+ type MockResponseCache struct

+ DeleteFunc func(key string) error

+ GetFunc func(key string, req *http.Request) (*Entry, error)

+ SetFunc func(key string, entry *Entry) error

+ func (m *MockResponseCache) Delete(key string) error

+ func (m *MockResponseCache) Get(key string, req *http.Request) (*Entry, error)

+ func (m *MockResponseCache) Set(key string, entry *Entry) error

+ type MockResponseStorer struct

+ StoreResponseFunc func(resp *http.Response, key string, reqTime, respTime time.Time) error

+ func (m *MockResponseStorer) StoreResponse(resp *http.Response, key string, reqTime, respTime time.Time) error

+ type MockRoundTripper struct

+ RoundTripFunc func(req *http.Request) (*http.Response, error)

+ func (m *MockRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

+ type MockStaleIfErrorPolicy struct

+ CanStaleOnErrorFunc func(freshness *Freshness, sies ...StaleIfErrorer) bool

+ func (m *MockStaleIfErrorPolicy) CanStaleOnError(freshness *Freshness, sies ...StaleIfErrorer) bool

+ type MockValidationResponseHandler struct

+ HandleValidationResponseFunc func(ctx RevalidationContext, req *http.Request, resp *http.Response, err error) (*http.Response, error)

+ func (m *MockValidationResponseHandler) HandleValidationResponse(ctx RevalidationContext, req *http.Request, resp *http.Response, err error) (*http.Response, error)

+ type MockVaryMatcher struct

+ VaryHeadersMatchFunc func(cachedHdr, reqHdr http.Header) bool

+ func (m *MockVaryMatcher) VaryHeadersMatch(cachedHdr, reqHdr http.Header) bool

+ type RawCSVSeq string

+ func (s RawCSVSeq) Value() (seq iter.Seq[string], valid bool)

+ type RawDeltaSeconds string

+ func (r RawDeltaSeconds) Value() (dur time.Duration, valid bool)

+ type RawTime string

+ func (r RawTime) Value() (t time.Time, valid bool)

+ type RequestMethodChecker interface

+ IsRequestMethodUnderstood func(req *http.Request) bool

+ func NewRequestMethodChecker() RequestMethodChecker

+ type RequestMethodCheckerFunc func(req *http.Request) bool

+ func (f RequestMethodCheckerFunc) IsRequestMethodUnderstood(req *http.Request) bool

+ type ResponseCache interface

+ Delete func(key string) error

+ Get func(key string, req *http.Request) (*Entry, error)

+ Set func(key string, entry *Entry) error

+ type ResponseStorer interface

+ StoreResponse func(resp *http.Response, key string, reqTime, respTime time.Time) error

+ func NewResponseStorer(cache ResponseCache) ResponseStorer

+ type RevalidationContext struct

+ CCReq CCRequestDirectives

+ CacheKey string

+ End time.Time

+ Freshness *Freshness

+ Start time.Time

+ Stored *Entry

+ type StaleIfErrorPolicy interface

+ CanStaleOnError func(freshness *Freshness, sies ...StaleIfErrorer) bool

+ type StaleIfErrorer interface

+ StaleIfError func() (dur time.Duration, valid bool)

+ type ValidationResponseHandler interface

+ HandleValidationResponse func(ctx RevalidationContext, req *http.Request, resp *http.Response, err error) (*http.Response, error)

+ type VaryMatcher interface

+ VaryHeadersMatch func(cachedHdr, reqHdr http.Header) bool

+ func NewVaryMatcher() VaryMatcher

+ type VaryMatcherFunc func(cachedHdr, reqHdr http.Header) bool

+ func (f VaryMatcherFunc) VaryHeadersMatch(cachedHdr, reqHdr http.Header) bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL