s3

README

go-whosonfirst-cache-s3

Install

You will need to have both Go (specifically version Go 1.12 or higher) and the make programs installed on your computer. Assuming you do just type:

make bin

All of this package's dependencies are bundled with the code in the vendor directory.

See also

• https://github.com/whosonfirst/go-whosonfirst-cache
• https://github.com/whosonfirst/go-whosonfirst-aws

Documentation

Index

• func NewS3Cache(dsn string, opts *S3CacheOptions) (cache.Cache, error)
• type S3Cache
  • func (c *S3Cache) Evictions() int64
  • func (c *S3Cache) Get(key string) (io.ReadCloser, error)
  • func (c *S3Cache) Hits() int64
  • func (c *S3Cache) Misses() int64
  • func (c *S3Cache) Name() string
  • func (c *S3Cache) Set(key string, fh io.ReadCloser) (io.ReadCloser, error)
  • func (c *S3Cache) Size() int64
  • func (c *S3Cache) Unset(key string) error
• type S3CacheOptions
  • func NewS3CacheOptionsFromDefaults() (*S3CacheOptions, error)
  • func NewS3CacheOptionsFromString(str_opts string) (*S3CacheOptions, error)

Functions

func NewS3Cache

func NewS3Cache(dsn string, opts *S3CacheOptions) (cache.Cache, error)

Types

type S3Cache

type S3Cache struct {
	cache.Cache
	// contains filtered or unexported fields
}

func (*S3Cache) Evictions

func (c *S3Cache) Evictions() int64

func (*S3Cache) Get

func (c *S3Cache) Get(key string) (io.ReadCloser, error)

func (*S3Cache) Hits

func (c *S3Cache) Hits() int64

func (*S3Cache) Misses

func (c *S3Cache) Misses() int64

func (*S3Cache) Name

func (c *S3Cache) Name() string

func (*S3Cache) Set

func (c *S3Cache) Set(key string, fh io.ReadCloser) (io.ReadCloser, error)

func (*S3Cache) Size

func (c *S3Cache) Size() int64

func (*S3Cache) Unset

func (c *S3Cache) Unset(key string) error

type S3CacheOptions

type S3CacheOptions struct {
	ACL string
}

func NewS3CacheOptionsFromDefaults

func NewS3CacheOptionsFromDefaults() (*S3CacheOptions, error)

func NewS3CacheOptionsFromString

func NewS3CacheOptionsFromString(str_opts string) (*S3CacheOptions, error)