streams

Documentation

Index

• func DecryptStreamInfo(ctx context.Context, streamMetaBytes []byte, path storj.Path, ...) (streamInfo []byte, streamMeta pb.StreamMeta, err error)
• func EncryptAfterBucket(ctx context.Context, path storj.Path, cipher storj.Cipher, key *storj.Key) (encrypted storj.Path, err error)
• func TypedDecryptStreamInfo(ctx context.Context, streamMetaBytes []byte, path Path, ...) (streamInfo []byte, streamMeta pb.StreamMeta, err error)
• type EOFReader
  • func NewEOFReader(r io.Reader) *EOFReader
  • func (r *EOFReader) Read(p []byte) (n int, err error)
• type ListItem
• type Meta
• type Path
  • func CreatePath(bucket string, unencPath paths.Unencrypted) (path Path)
  • func ParsePath(raw storj.Path) (path Path)
  • func (p Path) Bucket() string
  • func (p Path) Raw() []byte
  • func (p Path) String() string
  • func (p Path) UnencryptedPath() paths.Unencrypted
• type SizeReader
  • func NewSizeReader(r io.Reader) *SizeReader
  • func (r *SizeReader) Read(p []byte) (n int, err error)
  • func (r *SizeReader) Size() int64
• type Store
  • func NewStreamStore(segments segments.Store, segmentSize int64, encStore *encryption.Store, ...) (Store, error)

Functions

func DecryptStreamInfo

func DecryptStreamInfo(ctx context.Context, streamMetaBytes []byte, path storj.Path, rootKey *storj.Key) (
	streamInfo []byte, streamMeta pb.StreamMeta, err error)

DecryptStreamInfo decrypts stream info. This is a legacy function that should no longer be needed after the typed path refactoring.

func EncryptAfterBucket

func EncryptAfterBucket(ctx context.Context, path storj.Path, cipher storj.Cipher, key *storj.Key) (encrypted storj.Path, err error)

EncryptAfterBucket encrypts a path without encrypting its first element. This is a legacy function that should no longer be needed after the typed path refactoring.

func TypedDecryptStreamInfo

func TypedDecryptStreamInfo(ctx context.Context, streamMetaBytes []byte, path Path, encStore *encryption.Store) (
	streamInfo []byte, streamMeta pb.StreamMeta, err error)

TypedDecryptStreamInfo decrypts stream info

Types

type EOFReader

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

EOFReader holds reader and status of EOF

func NewEOFReader

func NewEOFReader(r io.Reader) *EOFReader

NewEOFReader keeps track of the state, has the internal reader reached EOF

func (*EOFReader) Read

func (r *EOFReader) Read(p []byte) (n int, err error)

type ListItem

type ListItem struct {
	Path     string
	Meta     Meta
	IsPrefix bool
}

ListItem is a single item in a listing

type Meta

type Meta struct {
	Modified   time.Time
	Expiration time.Time
	Size       int64
	Data       []byte
}

Meta info about a stream

type Path

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

Path is a representation of an object path within a bucket

func CreatePath

func CreatePath(bucket string, unencPath paths.Unencrypted) (path Path)

CreatePath will create a Path for the provided information.

func ParsePath

func ParsePath(raw storj.Path) (path Path)

ParsePath returns a new Path with the given raw bytes.

func (Path) Bucket

func (p Path) Bucket() string

Bucket returns the bucket part of the path.

func (Path) Raw

func (p Path) Raw() []byte

Raw returns the raw data in the path.

func (Path) String

func (p Path) String() string

String returns the string form of the raw data in the path.

func (Path) UnencryptedPath

func (p Path) UnencryptedPath() paths.Unencrypted

UnencryptedPath returns the unencrypted path part of the path.

type SizeReader

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

SizeReader holds reader and size read so far

func NewSizeReader

func NewSizeReader(r io.Reader) *SizeReader

NewSizeReader keeps track of how much bytes are read from the reader

func (*SizeReader) Read

func (r *SizeReader) Read(p []byte) (n int, err error)

func (*SizeReader) Size

func (r *SizeReader) Size() int64

Size returns the number of bytes read so far

type Store

type Store interface {
	Meta(ctx context.Context, path storj.Path, pathCipher storj.Cipher) (Meta, error)
	Get(ctx context.Context, path storj.Path, pathCipher storj.Cipher) (ranger.Ranger, Meta, error)
	Put(ctx context.Context, path storj.Path, pathCipher storj.Cipher, data io.Reader, metadata []byte, expiration time.Time) (Meta, error)
	Delete(ctx context.Context, path storj.Path, pathCipher storj.Cipher) error
	List(ctx context.Context, prefix, startAfter, endBefore storj.Path, pathCipher storj.Cipher, recursive bool, limit int, metaFlags uint32) (items []ListItem, more bool, err error)
}

Store interface methods for streams to satisfy to be a store

func NewStreamStore

func NewStreamStore(segments segments.Store, segmentSize int64, encStore *encryption.Store, encBlockSize int, cipher storj.Cipher, inlineThreshold int) (Store, error)

NewStreamStore constructs a Store.