Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

client

package

Go to main page

Versions in this module

v0

v0.8.8

May 27, 2026

v0.8.7

May 13, 2026

v0.8.6

May 13, 2026

v0.8.5

May 12, 2026

v0.8.4

May 12, 2026

Changes in this version

type Client

+ func (c *Client) Can(ctx context.Context, capability string) (bool, error)

v0.8.3

May 12, 2026

Changes in this version

+ var ErrAllEndpointsFailed = ewrap.New("hypercache: all endpoints failed")

+ var ErrBadRequest = ewrap.New("hypercache: bad request")

+ var ErrDraining = ewrap.New("hypercache: cluster draining")

+ var ErrForbidden = ewrap.New("hypercache: forbidden")

+ var ErrInternal = ewrap.New("hypercache: internal server error")

+ var ErrNoEndpoints = ewrap.New("hypercache: at least one endpoint required")

+ var ErrNotFound = ewrap.New("hypercache: key not found")

+ var ErrUnauthorized = ewrap.New("hypercache: unauthorized")

+ type BatchDeleteResult struct

+ Deleted bool

+ Err *StatusError

+ Key string

+ Owners []string

+ type BatchGetResult struct

+ Found bool

+ Item *Item

+ Key string

+ type BatchPutResult struct

+ Bytes int

+ Err *StatusError

+ Key string

+ Owners []string

+ Stored bool

+ type BatchSetItem struct

+ Key string

+ TTL time.Duration

+ Value []byte

+ type Client struct

+ func New(seeds []string, opts ...Option) (*Client, error)

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

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

+ func (c *Client) BatchSet(ctx context.Context, items []BatchSetItem) ([]BatchPutResult, error)

+ func (c *Client) Close() error

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

+ func (c *Client) Endpoints() []string

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

+ func (c *Client) GetItem(ctx context.Context, key string) (*Item, error)

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

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

+ func (c *Client) Set(ctx context.Context, key string, value []byte, ttl time.Duration) error

+ type Identity struct

+ Capabilities []string

+ ID string

+ Scopes []string

+ func (i Identity) HasCapability(name string) bool

+ type Item struct

+ ExpiresAt string

+ Key string

+ LastUpdated string

+ Node string

+ Origin string

+ Owners []string

+ TTLMs int64

+ Value []byte

+ Version uint64

+ type Option func(*Client) error

+ func WithBasicAuth(username, password string) Option

+ func WithBearerAuth(token string) Option

+ func WithHTTPClient(httpClient *http.Client) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithOIDCClientCredentials(cfg clientcredentials.Config) Option

+ func WithTopologyRefresh(interval time.Duration) Option

+ type StatusError struct

+ Code string

+ Details string

+ HTTPStatus int

+ Message string

+ func (e *StatusError) Error() string

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