file

Documentation

Index

• Constants
• Variables
• type DelRequest
• type Factory
  • func NewFileFactory(CompType string, f func() File) *Factory
• type File
• type FileConfig
• type FileMetaRequest
• type FileMetaResp
• type FileStoreRegistry
  • func (r *FileStoreRegistry) Create(compType string) (File, error)
  • func (r *FileStoreRegistry) Register(fs ...*Factory)
• type FilesInfo
• type GetFileStu
• type ListRequest
• type ListResp
• type PutFileStu
• type Registry
  • func NewRegistry(info *info.RuntimeInfo) Registry

Constants

const ServiceName = "file"

Variables

var (
	ErrInvalid    = errors.New("invalid argument")
	ErrPermission = errors.New("permission denied")
	ErrExist      = errors.New("file already exists")
	ErrNotExist   = errors.New("file does not exist")
	ErrExpired    = errors.New("file expired")
)

Types

type DelRequest

type DelRequest struct {
	FileName string
	Metadata map[string]string
}

type Factory

type Factory struct {
	CompType      string
	FactoryMethod func() File
}

func NewFileFactory

func NewFileFactory(CompType string, f func() File) *Factory

type File

type File interface {
	Init(context.Context, *FileConfig) error
	Put(context.Context, *PutFileStu) error
	Get(context.Context, *GetFileStu) (io.ReadCloser, error)
	List(context.Context, *ListRequest) (*ListResp, error)
	Del(context.Context, *DelRequest) error
	Stat(context.Context, *FileMetaRequest) (*FileMetaResp, error)
}

type FileConfig

type FileConfig struct {
	ref.Config
	Metadata json.RawMessage `json:"metadata"`
	Type     string          `json:"type"`
}

FileConfig wraps configuration for a file implementation

type FileMetaRequest

type FileMetaRequest struct {
	FileName string
	Metadata map[string]string
}

type FileMetaResp

type FileMetaResp struct {
	Size         int64
	LastModified string
	Metadata     map[string][]string
}

type FileStoreRegistry

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

func (*FileStoreRegistry) Create

func (r *FileStoreRegistry) Create(compType string) (File, error)

func (*FileStoreRegistry) Register

func (r *FileStoreRegistry) Register(fs ...*Factory)

type FilesInfo

type FilesInfo struct {
	FileName     string
	Size         int64
	LastModified string
	Meta         map[string]string
}

type GetFileStu

type GetFileStu struct {
	FileName string
	Metadata map[string]string
}

type ListRequest

type ListRequest struct {
	DirectoryName string
	Marker        string
	PageSize      int32
	Metadata      map[string]string
}

type ListResp

type ListResp struct {
	Files       []*FilesInfo
	Marker      string
	IsTruncated bool
}

type PutFileStu

type PutFileStu struct {
	DataStream io.Reader
	FileName   string
	Metadata   map[string]string
}

type Registry

type Registry interface {
	Register(fs ...*Factory)
	Create(compType string) (File, error)
}

func NewRegistry

func NewRegistry(info *info.RuntimeInfo) Registry