stream

Documentation

Index

• Variables
• type Download
  • func NewDownload(ctx context.Context, stream storj.ReadOnlyStream, streams streams.Store) *Download
  • func (download *Download) Close() error
  • func (download *Download) Read(data []byte) (n int, err error)
  • func (download *Download) Seek(offset int64, whence int) (int64, error)
• type Upload
  • func NewUpload(ctx context.Context, stream storj.MutableStream, streams streams.Store) *Upload
  • func (upload *Upload) Close() error
  • func (upload *Upload) Write(data []byte) (n int, err error)

Variables

var Error = errs.Class("stream error")

Error is the errs class of stream errors

Types

type Download

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

Download implements Reader, Seeker and Closer for reading from stream.

func NewDownload

func NewDownload(ctx context.Context, stream storj.ReadOnlyStream, streams streams.Store) *Download

NewDownload creates new stream download.

func (*Download) Close

func (download *Download) Close() error

Close closes the stream and releases the underlying resources.

func (*Download) Read

func (download *Download) Read(data []byte) (n int, err error)

Read reads up to len(data) bytes into data.

If this is the first call it will read from the beginning of the stream. Use Seek to change the current offset for the next Read call.

See io.Reader for more details.

func (*Download) Seek

func (download *Download) Seek(offset int64, whence int) (int64, error)

Seek changes the offset for the next Read call.

See io.Seeker for more details.

type Upload

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

Upload implements Writer and Closer for writing to stream.

func NewUpload

func NewUpload(ctx context.Context, stream storj.MutableStream, streams streams.Store) *Upload

NewUpload creates new stream upload.

func (*Upload) Close

func (upload *Upload) Close() error

Close closes the stream and releases the underlying resources.

func (*Upload) Write

func (upload *Upload) Write(data []byte) (n int, err error)

Write writes len(data) bytes from data to the underlying data stream.

See io.Writer for more details.