filab

README

filab

FILe ABstraction library

Documentation

Index

• Constants
• func Exist(ctx context.Context, p Path) (bool, error)
• func MaybeAddCompression(file string, w io.WriteCloser) (io.WriteCloser, error)
• func MaybeAddDecompression(file string, r io.ReadCloser) (io.ReadCloser, error)
• func NewReader(ctx context.Context, p Path) (io.ReadCloser, error)
• func NewWriter(ctx context.Context, p Path) (io.WriteCloser, error)
• func RegisterDriver(driver StorageDriver) error
• func Walk(ctx context.Context, p Path, w WalkFunc)
• type DriverType
• type FileStorage
  • func DefaultFileStore() FileStorage
  • func New() FileStorage
• type FileStoreBase
• type Path
  • func List(ctx context.Context, p Path) ([]Path, error)
  • func MustParse(s string) Path
  • func Parse(s string) (Path, error)
• type StorageDriver
• type WalkFunc

Constants

const DefaultProtoMaxSize = 10000000

Functions

func Exist

func Exist(ctx context.Context, p Path) (bool, error)

func MaybeAddCompression

func MaybeAddCompression(file string, w io.WriteCloser) (io.WriteCloser, error)

func MaybeAddDecompression

func MaybeAddDecompression(file string, r io.ReadCloser) (io.ReadCloser, error)

func NewReader

func NewReader(ctx context.Context, p Path) (io.ReadCloser, error)

func NewWriter

func NewWriter(ctx context.Context, p Path) (io.WriteCloser, error)

func RegisterDriver

func RegisterDriver(driver StorageDriver) error

func Walk

func Walk(ctx context.Context, p Path, w WalkFunc)

Types

type DriverType

type DriverType *string

type FileStorage

type FileStorage interface {
	RegisterDriver(driver StorageDriver) error

	FileStoreBase

	MustParse(p string) Path

	NewReaderS(p Path) (io.ReadCloser, error)
	NewPbReaderS(p Path) (pbio.ReadCloser, error)

	NewWriterS(p Path) (io.WriteCloser, error)
	NewPbWriterS(p Path) (pbio.WriteCloser, error)
}

func DefaultFileStore

func DefaultFileStore() FileStorage

func New

func New() FileStorage

type FileStoreBase

type FileStoreBase interface {
	Parse(s string) (Path, error)
	Exist(context.Context, Path) (bool, error)
	Delete(context.Context, Path) error
	NewReader(context.Context, Path) (io.ReadCloser, error)
	NewWriter(context.Context, Path) (io.WriteCloser, error)
	List(context.Context, Path) ([]Path, error)
	Walk(context.Context, Path, WalkFunc) error
}

type Path

type Path interface {
	Join(p ...string) Path
	String() string
	Copy() Path
	Dir() Path
	Type() DriverType

	DirStr() string
	BaseStr() string
}

func List

func List(ctx context.Context, p Path) ([]Path, error)

func MustParse

func MustParse(s string) Path

func Parse

func Parse(s string) (Path, error)

type StorageDriver

type StorageDriver interface {
	Name() string
	Scheme() string
	Type() DriverType

	FileStoreBase
}

type WalkFunc

type WalkFunc func(p Path, err error) error