streams

Documentation

Index

• func PathForKey(raw string) paths.Unencrypted
• func TypedDecryptStreamInfo(ctx context.Context, streamMetaBytes []byte, path Path, ...) (_ *pb.StreamInfo, 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 Metadata
• 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 PeekThresholdReader
  • func NewPeekThresholdReader(r io.Reader) (pt *PeekThresholdReader)
  • func (pt *PeekThresholdReader) IsLargerThan(thresholdSize int) (bool, error)
  • func (pt *PeekThresholdReader) Read(p []byte) (n int, err error)
• type Store
  • func NewStreamStore(metainfo *metainfo.Client, segments segments.Store, segmentSize int64, ...) (Store, error)

Functions

func PathForKey

func PathForKey(raw string) paths.Unencrypted

PathForKey removes the trailing `/` from the raw path, which is required so the derived key matches the final list path (which also has the trailing encrypted `/` part of the path removed).

func TypedDecryptStreamInfo

func TypedDecryptStreamInfo(ctx context.Context, streamMetaBytes []byte, path Path, encStore *encryption.Store) (
	_ *pb.StreamInfo, 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 Metadata

type Metadata interface {
	Metadata() ([]byte, error)
}

Metadata interface returns the latest metadata for an object.

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 PeekThresholdReader

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

PeekThresholdReader allows a check to see if the size of a given reader exceeds the maximum inline segment size or not.

func NewPeekThresholdReader

func NewPeekThresholdReader(r io.Reader) (pt *PeekThresholdReader)

NewPeekThresholdReader creates a new instance of PeekThresholdReader.

func (*PeekThresholdReader) IsLargerThan

func (pt *PeekThresholdReader) IsLargerThan(thresholdSize int) (bool, error)

IsLargerThan returns a bool to determine whether a reader's size is larger than the given threshold or not.

func (*PeekThresholdReader) Read

func (pt *PeekThresholdReader) Read(p []byte) (n int, err error)

Read initially reads bytes from the internal buffer, then continues reading from the wrapped data reader. The number of bytes read `n` is returned.

type Store

type Store interface {
	Get(ctx context.Context, path storj.Path, object storj.Object) (ranger.Ranger, error)
	Put(ctx context.Context, path storj.Path, data io.Reader, metadata Metadata, expiration time.Time) (Meta, error)
	Delete(ctx context.Context, path storj.Path) (storj.ObjectInfo, error)
}

Store interface methods for streams to satisfy to be a store.

func NewStreamStore

func NewStreamStore(metainfo *metainfo.Client, segments segments.Store, segmentSize int64, encStore *encryption.Store, encBlockSize int, cipher storj.CipherSuite, inlineThreshold int, maxEncryptedSegmentSize int64) (Store, error)

NewStreamStore constructs a Store.