segments

Documentation

Index

• Variables
• func CalcNeededNodes(rs *pb.RedundancyScheme) int32
• type ListItem
• type Meta
• 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 SizedReader
  • func SizeReader(r io.Reader) *SizedReader
  • func (r *SizedReader) Read(p []byte) (n int, err error)
  • func (r *SizedReader) Size() int64
• type Store
  • func NewSegmentStore(metainfo *metainfo.Client, ec ecclient.Client, rs eestream.RedundancyStrategy, ...) Store

Variables

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

Error is the errs class of standard segment errors

Functions

func CalcNeededNodes

func CalcNeededNodes(rs *pb.RedundancyScheme) int32

CalcNeededNodes calculate how many minimum nodes are needed for download, based on t = k + (n-o)k/o

Types

type ListItem

type ListItem struct {
	Path     storj.Path
	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 segment

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 SizedReader

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

SizedReader allows to check the total number of bytes read so far.

func SizeReader

func SizeReader(r io.Reader) *SizedReader

SizeReader create a new instance of SizedReader.

func (*SizedReader) Read

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

Read implements io.Reader.Read

func (*SizedReader) Size

func (r *SizedReader) Size() int64

Size returns the total number of bytes read so far.

type Store

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

Store for segments

func NewSegmentStore

func NewSegmentStore(metainfo *metainfo.Client, ec ecclient.Client, rs eestream.RedundancyStrategy, threshold int, maxEncryptedSegmentSize int64) Store

NewSegmentStore creates a new instance of segmentStore