fsds

Documentation

Index

• Variables
• type DirEntry
  • func NewDirEntry(entry domain.DirEntry) *DirEntry
  • func NewDirEntryWithMode(entry domain.DirEntry, mode os.FileMode) *DirEntry
  • func (d *DirEntry) Ctime() time.Time
  • func (d *DirEntry) Gid() string
  • func (d *DirEntry) IsDir() bool
  • func (d *DirEntry) ModTime() time.Time
  • func (d *DirEntry) Mode() os.FileMode
  • func (d *DirEntry) Name() string
  • func (d *DirEntry) Path() string
  • func (d *DirEntry) Size() uint64
  • func (d *DirEntry) Uid() string
• type FSDataSource
• type FSDataSourceConfig
  • func WithFilesDataSources(service space.Service) FSDataSourceConfig
  • func WithSharedWithMeDataSources(service space.Service) FSDataSourceConfig
  • func WithTLFDataSource(source *TLFDataSource) FSDataSourceConfig
• type FileReadWriterCloser
• type SpaceFSDataSource
  • func NewSpaceFSDataSource(service space.Service, configOptions ...FSDataSourceConfig) *SpaceFSDataSource
  • func (d *SpaceFSDataSource) CreateEntry(ctx context.Context, path string, mode os.FileMode) (*DirEntry, error)
  • func (d *SpaceFSDataSource) Get(ctx context.Context, path string) (*DirEntry, error)
  • func (d *SpaceFSDataSource) GetChildren(ctx context.Context, path string) ([]*DirEntry, error)
  • func (d *SpaceFSDataSource) Open(ctx context.Context, path string) (FileReadWriterCloser, error)
• type TLFDataSource

Variables

var DefaultBucketName = "personal"

var EntryNotFound = syscall.ENOENT // errors.New("Directory entry not found")

EntryNotFound error when a directory is not found

var RestrictedDirAccessMode = os.ModeDir | 0500 // dr-x------ only allow reading and opening directory for user

var StandardDirAccessMode = os.ModeDir | 0700 // drwx------

var StandardFileAccessMode os.FileMode = 0600 // -rw-------

Types

type DirEntry

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

DirEntry implements the DirEntryOps

func NewDirEntry

func NewDirEntry(entry domain.DirEntry) *DirEntry

func NewDirEntryWithMode

func NewDirEntryWithMode(entry domain.DirEntry, mode os.FileMode) *DirEntry

func (*DirEntry) Ctime

func (d *DirEntry) Ctime() time.Time

Ctime implements the DirEntryAttribute Interface It returns the time the directory was created

func (*DirEntry) Gid

func (d *DirEntry) Gid() string

func (*DirEntry) IsDir

func (d *DirEntry) IsDir() bool

IsDir implement DirEntryAttribute And returns if the directory is a boolean or not

func (*DirEntry) ModTime

func (d *DirEntry) ModTime() time.Time

ModTime returns the modification time

func (*DirEntry) Mode

func (d *DirEntry) Mode() os.FileMode

Mode implements the DirEntryAttribute Interface Currently if it is a file, returns all access permission 0766 but ideally should restrict the permission if owner is not the same as file

func (*DirEntry) Name

func (d *DirEntry) Name() string

Name implements the DirEntryAttribute Interface

func (*DirEntry) Path

func (d *DirEntry) Path() string

func (*DirEntry) Size

func (d *DirEntry) Size() uint64

Size implements the DirEntryAttribute Interface and return the size of the item

func (*DirEntry) Uid

func (d *DirEntry) Uid() string

type FSDataSource

type FSDataSource interface {
	// Get a single node, this can be called on either a file or folder entry
	// This is typically used by the OS for lookup of the information about the entry at path
	Get(ctx context.Context, path string) (*DirEntry, error)
	// GetChildren returns child entries in the directory/folder
	GetChildren(ctx context.Context, path string) ([]*DirEntry, error)
	// OpenReader returns a file reader
	Open(ctx context.Context, path string) (FileReadWriterCloser, error)
	// CreateEntry should create a directory or file based on the mode at the path
	CreateEntry(ctx context.Context, path string, mode os.FileMode) (*DirEntry, error)
}

FSDataSource is data source of file/directories and their information It is used as a local/remote cache for looking up information about the directories. It should also ensure that the user in the context has permission to data that is being request

type FSDataSourceConfig

type FSDataSourceConfig func(config *dataSourceConfig)

func WithFilesDataSources

func WithFilesDataSources(service space.Service) FSDataSourceConfig

Configure the default 'Files` data source to be included as a data source

func WithSharedWithMeDataSources

func WithSharedWithMeDataSources(service space.Service) FSDataSourceConfig

Configure the default 'Shared With Me` data source to be included as a data source

func WithTLFDataSource

func WithTLFDataSource(source *TLFDataSource) FSDataSourceConfig

type FileReadWriterCloser

type FileReadWriterCloser interface {
	Read(ctx context.Context, data []byte, offset int64) (int, error)
	Write(ctx context.Context, data []byte, offset int64) (int, error)
	Close(ctx context.Context) error
}

FileReadWriterCloser implements interfaces to read, copy, seek and close.

type SpaceFSDataSource

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

SpaceFSDataSource is an implementation of the FSDataSource It interacts with the Space Service Layer to provide data

func NewSpaceFSDataSource

func NewSpaceFSDataSource(service space.Service, configOptions ...FSDataSourceConfig) *SpaceFSDataSource

func (*SpaceFSDataSource) CreateEntry

func (d *SpaceFSDataSource) CreateEntry(ctx context.Context, path string, mode os.FileMode) (*DirEntry, error)

CreateEntry creates a directory or file based on the mode at the path

func (*SpaceFSDataSource) Get

func (d *SpaceFSDataSource) Get(ctx context.Context, path string) (*DirEntry, error)

Get returns the DirEntry information for item at path

func (*SpaceFSDataSource) GetChildren

func (d *SpaceFSDataSource) GetChildren(ctx context.Context, path string) ([]*DirEntry, error)

GetChildren returns list of entries in a path

func (*SpaceFSDataSource) Open

func (d *SpaceFSDataSource) Open(ctx context.Context, path string) (FileReadWriterCloser, error)

Open is invoked to read the content of a file

type TLFDataSource

type TLFDataSource struct {
	FSDataSource
	// contains filtered or unexported fields
}

TLFDataSource represents a data source handler for a particular top level file.