ulfs

type BufferedReadHandle ¶ added in v1.57.1

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

BufferedReadHandle wraps a ReadHandler with an in-memory buffer.

func (b *BufferedReadHandle) Close() error

func (b *BufferedReadHandle) Info() ObjectInfo

func (b *BufferedReadHandle) Read(p []byte) (int, error)

type BytesPool ¶ added in v1.57.1

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

BytesPool is a fixed-size pool of []byte.

func NewBytesPool(size int) *BytesPool

func (pool *BytesPool) Get() []byte

func (pool *BytesPool) Put(buf []byte)

type CreateOptions ¶ added in v1.51.1

type CreateOptions struct {
	Expires    time.Time
	Metadata   map[string]string
	SinglePart bool
}

CreateOptions contains extra options to create an object.

type Filesystem ¶

type Filesystem interface {
	Close() error
	Open(ctx context.Context, loc ulloc.Location) (MultiReadHandle, error)
	Create(ctx context.Context, loc ulloc.Location, opts *CreateOptions) (MultiWriteHandle, error)
	Move(ctx context.Context, source, dest ulloc.Location) error
	Copy(ctx context.Context, source, dest ulloc.Location) error
	Remove(ctx context.Context, loc ulloc.Location, opts *RemoveOptions) error
	List(ctx context.Context, prefix ulloc.Location, opts *ListOptions) (ObjectIterator, error)
	IsLocalDir(ctx context.Context, loc ulloc.Location) bool
	Stat(ctx context.Context, loc ulloc.Location) (*ObjectInfo, error)
}

Filesystem represents either the local filesystem or the data backed by a project.

type FilesystemLocal ¶ added in v1.55.1

type FilesystemLocal interface {
	IsLocalDir(ctx context.Context, path string) bool
	Open(ctx context.Context, path string) (MultiReadHandle, error)
	Create(ctx context.Context, path string) (MultiWriteHandle, error)
	Move(ctx context.Context, oldpath string, newpath string) error
	Copy(ctx context.Context, oldpath string, newpath string) error
	Remove(ctx context.Context, path string, opts *RemoveOptions) error
	List(ctx context.Context, path string, opts *ListOptions) (ObjectIterator, error)
	Stat(ctx context.Context, path string) (*ObjectInfo, error)
}

FilesystemLocal is the interface for a local filesystem.

type FilesystemRemote ¶ added in v1.55.1

type FilesystemRemote interface {
	Close() error
	Open(ctx context.Context, bucket, key string) (MultiReadHandle, error)
	Create(ctx context.Context, bucket, key string, opts *CreateOptions) (MultiWriteHandle, error)
	Move(ctx context.Context, oldbucket, oldkey string, newbucket, newkey string) error
	Copy(ctx context.Context, oldbucket, oldkey string, newbucket, newkey string) error
	Remove(ctx context.Context, bucket, key string, opts *RemoveOptions) error
	List(ctx context.Context, bucket, key string, opts *ListOptions) ObjectIterator
	Stat(ctx context.Context, bucket, key string) (*ObjectInfo, error)
}

FilesystemRemote is the interface for a remote filesystem.

type GenericMultiReadHandle ¶

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

GenericMultiReadHandle can turn any GenericReader into a MultiReadHandle.

func NewGenericMultiReadHandle(r GenericReader, info ObjectInfo) *GenericMultiReadHandle

func (o *GenericMultiReadHandle) Close() error

func (o *GenericMultiReadHandle) Info(ctx context.Context) (*ObjectInfo, error)

func (o *GenericMultiReadHandle) Length() int64

func (o *GenericMultiReadHandle) NextPart(ctx context.Context, length int64) (ReadHandle, error)

func (o *GenericMultiReadHandle) SetOffset(offset int64) error

type GenericMultiWriteHandle ¶

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

GenericMultiWriteHandle implements MultiWriteHandle for *os.Files.

func NewGenericMultiWriteHandle(w GenericWriter) *GenericMultiWriteHandle

func (o *GenericMultiWriteHandle) Abort(ctx context.Context) error

func (o *GenericMultiWriteHandle) Commit(ctx context.Context) error

func (o *GenericMultiWriteHandle) NextPart(ctx context.Context, length int64) (WriteHandle, error)

type GenericReader ¶

type GenericReader interface {
	io.Closer
	io.ReaderAt
}

GenericReader is an interface that can be turned into a GenericMultiReadHandle.

type GenericWriter ¶

type GenericWriter interface {
	io.WriterAt
	Commit() error
	Abort() error
}

GenericWriter is an interface that can be turned into a GenericMultiWriteHandle.

type ListOptions ¶

type ListOptions struct {
	Recursive bool
	Pending   bool
	Expanded  bool
}

ListOptions describes options to the List command.

type Local ¶

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

Local implements something close to a filesystem but backed by the local disk.

func NewLocal(fs LocalBackend) *Local

func (l *Local) Copy(ctx context.Context, oldpath, newpath string) error

func (l *Local) Create(ctx context.Context, path string) (MultiWriteHandle, error)

func (l *Local) IsLocalDir(ctx context.Context, path string) bool

func (l *Local) List(ctx context.Context, path string, opts *ListOptions) (ObjectIterator, error)

func (l *Local) Move(ctx context.Context, oldpath, newpath string) error

func (l *Local) Open(ctx context.Context, path string) (MultiReadHandle, error)

func (l *Local) Remove(ctx context.Context, path string, opts *RemoveOptions) error

func (l *Local) Stat(ctx context.Context, path string) (*ObjectInfo, error)

type LocalBackend ¶ added in v1.55.1

type LocalBackend interface {
	Create(name string) (LocalBackendFile, error)
	MkdirAll(path string, perm os.FileMode) error
	Open(name string) (LocalBackendFile, error)
	Remove(name string) error
	Rename(oldname, newname string) error
	Stat(name string) (os.FileInfo, error)
}

LocalBackend abstracts what the Local filesystem interacts with.

type LocalBackendFile ¶ added in v1.55.1

type LocalBackendFile interface {
	io.Closer
	io.ReaderAt
	io.WriterAt
	Name() string
	Stat() (os.FileInfo, error)
	Readdir(int) ([]os.FileInfo, error)
}

LocalBackendFile represents a file in the filesystem.

type LocalBackendMem ¶ added in v1.55.1

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

LocalBackendMem implements LocalBackend with memory backed files.

func NewLocalBackendMem() *LocalBackendMem

func (l *LocalBackendMem) Create(name string) (LocalBackendFile, error)

func (l *LocalBackendMem) MkdirAll(name string, perm os.FileMode) error

func (l *LocalBackendMem) Open(name string) (LocalBackendFile, error)

func (l *LocalBackendMem) Remove(name string) error

func (l *LocalBackendMem) Rename(oldname, newname string) error

func (l *LocalBackendMem) Stat(name string) (os.FileInfo, error)

type LocalBackendOS ¶ added in v1.55.1

type LocalBackendOS struct{}

LocalBackendOS implements LocalBackend by using the os package.

func NewLocalBackendOS() *LocalBackendOS

func (l *LocalBackendOS) Create(name string) (LocalBackendFile, error)

func (l *LocalBackendOS) MkdirAll(path string, perm os.FileMode) error

func (l *LocalBackendOS) Open(name string) (LocalBackendFile, error)

func (l *LocalBackendOS) Remove(name string) error

func (l *LocalBackendOS) Rename(oldname, newname string) error

func (l *LocalBackendOS) Stat(name string) (os.FileInfo, error)

type Mixed ¶

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

Mixed dispatches to either the local or remote filesystem depending on the location.

func NewMixed(local FilesystemLocal, remote FilesystemRemote) *Mixed

func (m *Mixed) Close() error

func (m *Mixed) Copy(ctx context.Context, source, dest ulloc.Location) error

func (m *Mixed) Create(ctx context.Context, loc ulloc.Location, opts *CreateOptions) (MultiWriteHandle, error)

func (m *Mixed) IsLocalDir(ctx context.Context, loc ulloc.Location) bool

func (m *Mixed) List(ctx context.Context, prefix ulloc.Location, opts *ListOptions) (ObjectIterator, error)

func (m *Mixed) Move(ctx context.Context, source, dest ulloc.Location) error

func (m *Mixed) Open(ctx context.Context, loc ulloc.Location) (MultiReadHandle, error)

func (m *Mixed) Remove(ctx context.Context, loc ulloc.Location, opts *RemoveOptions) error

func (m *Mixed) Stat(ctx context.Context, loc ulloc.Location) (*ObjectInfo, error)

type MultiReadHandle ¶

type MultiReadHandle interface {
	io.Closer
	SetOffset(offset int64) error
	NextPart(ctx context.Context, length int64) (ReadHandle, error)
	Info(ctx context.Context) (*ObjectInfo, error)
	Length() int64
}

MultiReadHandle allows one to read different sections of something. The offset parameter can be negative to signal that the offset should start that many bytes back from the end. Any negative value for length indicates to read up to the end.

TODO: A negative offset requires a negative length, but there is no reason why that must be so.

type MultiWriteHandle ¶

type MultiWriteHandle interface {
	NextPart(ctx context.Context, length int64) (WriteHandle, error)
	Commit(ctx context.Context) error
	Abort(ctx context.Context) error
}

MultiWriteHandle lets one create multiple sequential WriteHandles for different sections of something.

The returned WriteHandle will error if data is attempted to be written past the provided length. A negative length implies an unknown amount of data, and future calls to NextPart will error.

type ObjectInfo ¶

type ObjectInfo struct {
	Loc           ulloc.Location
	IsPrefix      bool
	Created       time.Time
	ContentLength int64
	Expires       time.Time
	Metadata      uplink.CustomMetadata
}

ObjectInfo is a simpler *uplink.Object that contains the minimal information the uplink command needs that multiple types can be converted to.

type ObjectIterator ¶

type ObjectIterator interface {
	Next() bool
	Err() error
	Item() ObjectInfo
}

ObjectIterator is an interface type for iterating over objectInfo values.

type ReadHandle ¶

type ReadHandle interface {
	io.Closer
	io.Reader
	Info() ObjectInfo
}

ReadHandle is something that can be read from distinct parts possibly in parallel.

func NewBufferedReadHandle(ctx context.Context, reader ReadHandle, buf []byte) ReadHandle

type Remote ¶

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

Remote implements something close to a filesystem but backed by an uplink project.

func NewRemote(project *uplink.Project) *Remote

func (r *Remote) Close() error

func (r *Remote) Copy(ctx context.Context, oldbucket, oldkey, newbucket, newkey string) error

func (r *Remote) Create(ctx context.Context, bucket, key string, opts *CreateOptions) (MultiWriteHandle, error)

func (r *Remote) List(ctx context.Context, bucket, prefix string, opts *ListOptions) ObjectIterator

func (r *Remote) Move(ctx context.Context, oldbucket, oldkey, newbucket, newkey string) error

func (r *Remote) Open(ctx context.Context, bucket, key string) (MultiReadHandle, error)

func (r *Remote) Remove(ctx context.Context, bucket, key string, opts *RemoveOptions) error

func (r *Remote) Stat(ctx context.Context, bucket, key string) (*ObjectInfo, error)

type RemoveOptions ¶

type RemoveOptions struct {
	Pending bool
}

RemoveOptions describes options to the Remove command.

type WriteHandle ¶

type WriteHandle interface {
	io.Writer
	Commit() error
	Abort() error
}

WriteHandle is anything that can be written to with commit/abort semantics.