core

type CacheProvider struct {
	// URL to connect to the storage system.
	URL string `json:"url" yaml:"url"`
	// Path to the configuration file.
	Path string `json:"path" yaml:"path"`
	// Declare the cache provider directly in the Souin configuration.
	Configuration any `json:"configuration" yaml:"configuration"`
}

type Configuration struct {
	Provider CacheProvider `json:"provider"`
	Stale    time.Duration `json:"stale"`
}

type KeyIndex struct {
	StoredAt      *timestamppb.Timestamp         `protobuf:"bytes,1,opt,name=stored_at,json=storedAt,proto3" json:"stored_at,omitempty"`
	FreshTime     *timestamppb.Timestamp         `protobuf:"bytes,2,opt,name=fresh_time,json=freshTime,proto3" json:"fresh_time,omitempty"`
	StaleTime     *timestamppb.Timestamp         `protobuf:"bytes,3,opt,name=stale_time,json=staleTime,proto3" json:"stale_time,omitempty"`
	VariedHeaders map[string]*KeyIndexStringList `` /* 188-byte string literal not displayed */
	Etag          string                         `protobuf:"bytes,5,opt,name=etag,proto3" json:"etag,omitempty"`
	RealKey       string                         `protobuf:"bytes,6,opt,name=real_key,json=realKey,proto3" json:"real_key,omitempty"`
	// contains filtered or unexported fields
}

type KeyIndexStringList struct {
	HeaderValue []string `protobuf:"bytes,1,rep,name=header_value,json=headerValue,proto3" json:"header_value,omitempty"`
	// contains filtered or unexported fields
}

type Logger interface {
	Debug(args ...interface{})
	Info(args ...interface{})
	Warn(args ...interface{})
	Error(args ...interface{})
	DPanic(args ...interface{})
	Panic(args ...interface{})
	Fatal(args ...interface{})
	Debugf(template string, args ...interface{})
	Infof(template string, args ...interface{})
	Warnf(template string, args ...interface{})
	Errorf(template string, args ...interface{})
	DPanicf(template string, args ...interface{})
	Panicf(template string, args ...interface{})
	Fatalf(template string, args ...interface{})
}

type MappingWalker interface {
	WalkMappings(prefix string, fn func(key string, value []byte) bool) error
}

type Revalidator struct {
	Matched                     bool
	IfNoneMatchPresent          bool
	IfMatchPresent              bool
	IfModifiedSincePresent      bool
	IfUnmodifiedSincePresent    bool
	IfUnmotModifiedSincePresent bool
	NeedRevalidation            bool
	NotModified                 bool
	IfModifiedSince             time.Time
	IfUnmodifiedSince           time.Time
	IfNoneMatch                 []string
	IfMatch                     []string
	RequestETags                []string
	ResponseETag                string
}

type SetStorer interface {
	// AddToSet adds members to the set stored at key, extending the set
	// lifetime to at least the given duration when it is positive, without
	// shortening a longer remaining lifetime.
	AddToSet(key string, members []string, duration time.Duration) error
	// GetSet returns all members of the set stored at key.
	GetSet(key string) []string
	// WalkSets visits every set whose key matches the prefix. The walk stops
	// early when fn returns false. The key passed to fn is stripped of the
	// given prefix.
	WalkSets(prefix string, fn func(key string, members []string) bool) error
}

type StorageMapper struct {
	Mapping map[string]*KeyIndex `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

type Storer interface {
	MapKeys(prefix string) map[string]string
	ListKeys() []string
	Get(key string) []byte
	Set(key string, value []byte, duration time.Duration) error
	Delete(key string)
	DeleteMany(key string)
	Init() error
	Name() string
	Uuid() string
	Reset() error

	// Multi level storer to handle fresh/stale at once
	GetMultiLevel(key string, req *http.Request, validator *Revalidator) (fresh *http.Response, stale *http.Response)
	SetMultiLevel(baseKey, variedKey string, value []byte, variedHeaders http.Header, etag string, duration time.Duration, realKey string) error
}