s3fs

Documentation

Index

• Variables
• type File
  • func (f *File) Close() error
  • func (f *File) Key() string
  • func (f *File) Read(buf []byte) (int, error)
  • func (f *File) Stat() (ros.FileInfo, error)
  • func (f *File) Write(p []byte) (n int, err error)
• type Filesystem
  • func New(ctx context.Context, opts ...Option) (*Filesystem, error)
  • func (fs *Filesystem) Create(name string) (ros.File, error)
  • func (fs *Filesystem) Mkdir(name string, perm ros.FileMode) error
  • func (fs *Filesystem) MkdirAll(path string, perm ros.FileMode) error
  • func (fs *Filesystem) Open(name string) (ros.File, error)
  • func (fs *Filesystem) ReadDir(name string) ([]ros.DirEntry, error)
  • func (fs *Filesystem) ReadFile(name string) ([]byte, error)
  • func (fs *Filesystem) Remove(name string) error
  • func (fs *Filesystem) Rename(oldpath, newpath string) error
  • func (fs *Filesystem) Stat(name string) (ros.FileInfo, error)
  • func (fs *Filesystem) Symlink(oldname, newname string) error
  • func (fs *Filesystem) WriteFile(name string, data []byte, perm ros.FileMode) error
• type Option
  • func WithBase(dir string) Option
  • func WithBucket(bucket string) Option
  • func WithClient(client *s3.Client) Option

Variables

var (
	ErrMissingClient     = errors.New("missing s3 client")
	ErrMissingBucketName = errors.New("missing bucket name")
)

Types

type File

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

func (*File) Close

func (f *File) Close() error

func (*File) Key

func (f *File) Key() string

func (*File) Read

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

func (*File) Stat

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

func (*File) Write

func (f *File) Write(p []byte) (n int, err error)

type Filesystem

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

func New

func New(ctx context.Context, opts ...Option) (*Filesystem, error)

New creates a new S3 filesystem with the given options.

func (*Filesystem) Create

func (fs *Filesystem) Create(name string) (ros.File, error)

func (*Filesystem) Mkdir

func (fs *Filesystem) Mkdir(name string, perm ros.FileMode) error

func (*Filesystem) MkdirAll

func (fs *Filesystem) MkdirAll(path string, perm ros.FileMode) error

func (*Filesystem) Open

func (fs *Filesystem) Open(name string) (ros.File, error)

func (*Filesystem) ReadDir

func (fs *Filesystem) ReadDir(name string) ([]ros.DirEntry, error)

func (*Filesystem) ReadFile

func (fs *Filesystem) ReadFile(name string) ([]byte, error)

func (*Filesystem) Remove

func (fs *Filesystem) Remove(name string) error

func (*Filesystem) Rename

func (fs *Filesystem) Rename(oldpath, newpath string) error

func (*Filesystem) Stat

func (fs *Filesystem) Stat(name string) (ros.FileInfo, error)

func (*Filesystem) Symlink

func (fs *Filesystem) Symlink(oldname, newname string) error

func (*Filesystem) WriteFile

func (fs *Filesystem) WriteFile(name string, data []byte, perm ros.FileMode) error

type Option

type Option func(*Filesystem)

Option is a configuration function for an S3 Filesystem.

func WithBase

func WithBase(dir string) Option

WithBase sets the base directory for the filesystem.

func WithBucket

func WithBucket(bucket string) Option

WithBucket sets the S3 bucket name for the filesystem.

func WithClient

func WithClient(client *s3.Client) Option

WithClient sets the S3 client for the filesystem.