client

Jul 27, 2026

Changes in this version

+ var ErrUpToDate = errors.New("snapshot already up to date")

Jul 20, 2026

Changes in this version

+ func ParallelGetReader(ctx context.Context, c RangeReader, key Key, chunkSize int64, concurrency int) (io.ReadCloser, error)

Jul 13, 2026

Changes in this version

+ func FormatETag(etag string) (string, error)

+ func RawETagFromHeader(etag string) (string, error)

+ func ValidateRawETag(etag string) error

type Client

+ func (c *Client) Invalidate(ctx context.Context, key Key) error

+ func (c *Client) OpenGitSnapshotParallel(ctx context.Context, repoURL string, chunkSize int64, concurrency int) (*GitSnapshot, error)

type RequestOption

+ func WithETag(etag string) RequestOption

type RequestOptions

+ ETag string

+ ETagSet bool

+ func (o RequestOptions) IfRangeMisses(etag string) bool

Jun 24, 2026

Changes in this version

+ const BundleURLHeader

+ const ETagKey

+ const SnapshotCommitHeader

+ var ErrNotModified = errors.New("not modified")

+ var ErrPreconditionFailed = errors.New("precondition failed")

+ var ErrRangeNotSatisfiable = errors.New("range not satisfiable")

+ var ErrStatsUnavailable = errors.New("stats unavailable")

+ func Archive(ctx context.Context, w io.Writer, baseDir string, includePaths []string, ...) error

+ func Extract(ctx context.Context, r io.Reader, directory string, threads int) error

+ func NewHTTPClient(headerFunc HeaderFunc) *http.Client

+ func ParallelGet(ctx context.Context, c RangeReader, key Key, dst io.WriterAt, chunkSize int64, ...) error

+ func ValidateNamespace(name string) error

+ type CacheWriter interface

+ Abort func(err error) error

+ type Client struct

+ func New(baseURL string, headerFunc HeaderFunc) *Client

+ func NewWithHTTPClient(baseURL string, httpClient *http.Client) *Client

+ func (c *Client) BaseURL() string

+ func (c *Client) Close() error

+ func (c *Client) Create(ctx context.Context, key Key, headers http.Header, ttl time.Duration) (CacheWriter, error)

+ func (c *Client) Delete(ctx context.Context, key Key) error

+ func (c *Client) EnsureGitRefs(ctx context.Context, repoURL string, request EnsureGitRefsRequest) (EnsureGitRefsResponse, error)

+ func (c *Client) HTTP() *http.Client

+ func (c *Client) ListNamespaces(ctx context.Context) ([]string, error)

+ func (c *Client) Namespace(namespace Namespace) *Client

+ func (c *Client) Open(ctx context.Context, key Key, opts ...RequestOption) (io.ReadCloser, http.Header, error)

+ func (c *Client) OpenGitBundle(ctx context.Context, bundleURL string) (io.ReadCloser, error)

+ func (c *Client) OpenGitLFSSnapshot(ctx context.Context, repoURL string) (*GitSnapshot, error)

+ func (c *Client) OpenGitSnapshot(ctx context.Context, repoURL string) (*GitSnapshot, error)

+ func (c *Client) Restore(ctx context.Context, key Key, baseDir string, opts ...RestoreOption) (bool, error)

+ func (c *Client) Save(ctx context.Context, key Key, baseDir string, paths []string, ...) error

+ func (c *Client) Stat(ctx context.Context, key Key, opts ...RequestOption) (http.Header, error)

+ func (c *Client) Stats(ctx context.Context) (Stats, error)

+ func (c *Client) String() string

+ type EnsureGitRefsRequest struct

+ Commits []string

+ Refs map[string]string

+ type EnsureGitRefsResponse struct

+ Fetched bool

+ MissingCommits []string

+ Refs map[string]string

+ type GitSnapshot struct

+ Body io.ReadCloser

+ BundleURL string

+ Commit string

+ Headers http.Header

+ func (s *GitSnapshot) Close() error

+ type HTTPStatusError struct

+ StatusCode int

+ func (e *HTTPStatusError) Error() string

+ func (e *HTTPStatusError) Is(target error) bool

+ type HeaderFunc func() http.Header

+ type Key [32]byte

+ func HashFiles(patterns ...string) (Key, error)

+ func NewKey(s string) Key

+ func ParseKey(key string) (Key, error)

+ func (k *Key) MarshalText() ([]byte, error)

+ func (k *Key) String() string

+ func (k *Key) UnmarshalText(text []byte) error

+ type Namespace string

+ const DefaultNamespace

+ func ParseNamespace(name string) (Namespace, error)

+ func (n *Namespace) String() string

+ func (n *Namespace) UnmarshalText(text []byte) error

+ type RangeOutcome int

+ const RangeFull

+ const RangeNotSatisfiable

+ const RangePartial

+ type RangeReader interface

+ Open func(ctx context.Context, key Key, opts ...RequestOption) (io.ReadCloser, http.Header, error)

+ type RequestOption func(*RequestOptions)

+ func IfMatch(etag string) RequestOption

+ func IfNoneMatch(etag string) RequestOption

+ func IfRange(etag string) RequestOption

+ func Range(start, end int64) RequestOption

+ type RequestOptions struct

+ IfMatch string

+ IfNoneMatch string

+ IfRange string

+ Range string

+ func NewRequestOptions(opts ...RequestOption) RequestOptions

+ func (o RequestOptions) Check(etag string) error

+ func (o RequestOptions) ResolveRange(size int64, etag string) (start, length int64, outcome RangeOutcome)

+ type RestoreOption interface

+ type SaveOption interface

+ func WithExclude(patterns ...string) SaveOption

+ func WithExtraHeaders(h http.Header) SaveOption

+ func WithTTL(d time.Duration) SaveOption

+ type SaveRestoreOption interface

+ func WithZstdThreads(n int) SaveRestoreOption

+ type Stats struct

+ Capacity int64

+ Objects int64

+ Size int64