retriever

Documentation

Overview

Package retriever wraps functionality for fetching data from filecoin.

Index

• type EndpointFinder
• type Retriever
  • func NewRetriever(lassie lassietypes.Fetcher, endpointFinder EndpointFinder) *Retriever
  • func (r *Retriever) Retrieve(ctx context.Context, c cid.Cid, rangeStart int64, rangeEnd int64, sps []string, ...) error
  • func (r *Retriever) RetrieveReader(ctx context.Context, c cid.Cid, rangeStart int64, rangeEnd int64, sps []string) (io.ReadCloser, error)

Types

type EndpointFinder

type EndpointFinder interface {
	FindHTTPEndpoints(ctx context.Context, sps []string) ([]peer.AddrInfo, error)
}

EndpointFinder finds http endpoints for set of SPs

type Retriever

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

Retriever wraps Lassie and HTTP endpoint lookup to returns a byte stream for a cid at the root of a unixfs tree, from a list of Filecoin providers

func NewRetriever

func NewRetriever(lassie lassietypes.Fetcher, endpointFinder EndpointFinder) *Retriever

NewRetriever returns a new retriever instance

func (*Retriever) Retrieve

func (r *Retriever) Retrieve(ctx context.Context, c cid.Cid, rangeStart int64, rangeEnd int64, sps []string, out io.Writer) error

Retrieve retrieves a byte range from a cid representing a unixfstree from a given list of SPs, writing the output to a car file

func (*Retriever) RetrieveReader

func (r *Retriever) RetrieveReader(ctx context.Context, c cid.Cid, rangeStart int64, rangeEnd int64, sps []string) (io.ReadCloser, error)