localfs

Documentation

Index

• Constants
• func NewFS(cfgMap map[string]interface{}, opts ...Option) (qfs.Filesystem, error)
• func NewFilesystem(_ context.Context, cfgMap map[string]interface{}) (qfs.Filesystem, error)
• type FS
  • func (lfs *FS) Delete(ctx context.Context, path string) (err error)
  • func (lfs *FS) Get(ctx context.Context, path string) (qfs.File, error)
  • func (lfs *FS) Has(ctx context.Context, path string) (bool, error)
  • func (lfs *FS) Put(ctx context.Context, file qfs.File) (resultPath string, err error)
  • func (lfs *FS) Type() string
• type FSConfig
  • func DefaultFSConfig() *FSConfig
• type LocalFile
  • func (lf *LocalFile) FileName() string
  • func (lf *LocalFile) FullPath() string
  • func (lf *LocalFile) IsDirectory() bool
  • func (lf *LocalFile) MediaType() string
  • func (lf *LocalFile) ModTime() time.Time
  • func (lf *LocalFile) NextFile() (qfs.File, error)
• type Option
  • func OptionSetPWD(pwd string) Option

Constants

const FilestoreType = "local"

FilestoreType uniquely identifies this filestore

Functions

func NewFS

func NewFS(cfgMap map[string]interface{}, opts ...Option) (qfs.Filesystem, error)

NewFS creates a new local filesytem PathResolver

func NewFilesystem

func NewFilesystem(_ context.Context, cfgMap map[string]interface{}) (qfs.Filesystem, error)

NewFilesystem creates a new local filesystem Pathresolver with no options

Types

type FS

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

FS is a implementation of qfs.PathResolver that uses the local filesystem

func (*FS) Delete

func (lfs *FS) Delete(ctx context.Context, path string) (err error)

Delete removes a file or directory from the filesystem

func (*FS) Get

func (lfs *FS) Get(ctx context.Context, path string) (qfs.File, error)

Get implements qfs.PathResolver

func (*FS) Has

func (lfs *FS) Has(ctx context.Context, path string) (bool, error)

Has returns whether the store has a File with the key

func (*FS) Put

func (lfs *FS) Put(ctx context.Context, file qfs.File) (resultPath string, err error)

Put places a file or directory on the filesystem, returning the root path. The returned path may or may not honor the path of the given file

func (*FS) Type

func (lfs *FS) Type() string

Type distinguishes this filesystem from others by a unique string prefix

type FSConfig

type FSConfig struct {
	PWD string // working directory. defaults to system root
}

FSConfig adjusts the behaviour of an FS instance

func DefaultFSConfig

func DefaultFSConfig() *FSConfig

DefaultFSConfig is the configuration state with no additional options consumers of this package typically don't need to use this

type LocalFile

type LocalFile struct {
	os.File
	// contains filtered or unexported fields
}

LocalFile implements qfs.File with a filesystem file

func (*LocalFile) FileName

func (lf *LocalFile) FileName() string

FileName returns a filename associated with this file

func (*LocalFile) FullPath

func (lf *LocalFile) FullPath() string

FullPath returns the full path used when adding this file

func (*LocalFile) IsDirectory

func (lf *LocalFile) IsDirectory() bool

IsDirectory satisfies the qfs.File interface

func (*LocalFile) MediaType

func (lf *LocalFile) MediaType() string

MediaType returns a mime type based on file extension

func (*LocalFile) ModTime

func (lf *LocalFile) ModTime() time.Time

ModTime returns time of last modification, if any

func (*LocalFile) NextFile

func (lf *LocalFile) NextFile() (qfs.File, error)

NextFile satisfies the qfs.File interface

type Option

type Option func(cfgMap *FSConfig)

Option is a function type for passing to NewFS

func OptionSetPWD

func OptionSetPWD(pwd string) Option

OptionSetPWD sets the present working directory for the FS