s3httpfilesystem

README

s3httpfilesystem implements the http.FileSystem interface allowing an S3 bucket to be easily served over http.

Example:

package main

import (
	"net/http"

	s3 "github.com/jamesfcarter/s3httpfilesystem"
)

func main() {
	endpoint := "s3-us-west-2.amazonaws.com"
	bucket := "example"
	region := "us-west-2"
	// Credentials come from the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
	// environment variables.
	s3FileSystem := s3.New(endpoint, region, bucket)
	http.ListenAndServe(":80", http.FileServer(s3FileSystem))
}

Documentation

Index

• type File
  • func (f *File) Close() error
  • func (f *File) Read(p []byte) (int, error)
  • func (f *File) Readdir(count int) ([]os.FileInfo, error)
  • func (f *File) Seek(offset int64, whence int) (int64, error)
  • func (f *File) Stat() (os.FileInfo, error)
• type Filesystem
  • func New(endpoint, region, bucket string) *Filesystem
  • func NewWithS3(bucket string, mock s3Interface) *Filesystem
  • func (f *Filesystem) Open(path string) (http.File, error)

Types

type File

type File struct {
	// contains filtered or unexported fields
}

File implements the http.File interface for a S3 object or simulated directory.

func (*File) Close

func (f *File) Close() error

Close closes and removes a downloaded S3 object

func (*File) Read

func (f *File) Read(p []byte) (int, error)

Read reads from a downloaded S3 object as if it were a file

func (*File) Readdir

func (f *File) Readdir(count int) ([]os.FileInfo, error)

Readdir returns the contents of a simulated directory of S3 objects

func (*File) Seek

func (f *File) Seek(offset int64, whence int) (int64, error)

Seek sets the offset for the next Read of a downloaded S3 object

func (*File) Stat

func (f *File) Stat() (os.FileInfo, error)

Stat returns the FileInfo structure describing file.

type Filesystem

type Filesystem struct {
	// contains filtered or unexported fields
}

Filesystem implements the http.FileSystem interface for an S3 bucket.

func New

func New(endpoint, region, bucket string) *Filesystem

New builds and returns a new Filesystem accessing an S3. Credentials come from the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.

func NewWithS3

func NewWithS3(bucket string, mock s3Interface) *Filesystem

NewWithS3 takes an s3Interface and is used for testing

func (*Filesystem) Open

func (f *Filesystem) Open(path string) (http.File, error)

Open returns an http.File interface for an object or simulated directory within the S3 bucket.