indexerlookup

Documentation

Index

• type IndexerCandidateFinder
  • func NewCandidateFinder(o ...Option) (*IndexerCandidateFinder, error)
  • func (idxf *IndexerCandidateFinder) FindCandidates(ctx context.Context, cid cid.Cid) ([]types.RetrievalCandidate, error)
  • func (idxf *IndexerCandidateFinder) FindCandidatesAsync(ctx context.Context, c cid.Cid) (<-chan types.FindCandidatesResult, error)
• type Option
  • func WithAsyncResultsChanBuffer(i int) Option
  • func WithHttpClient(c *http.Client) Option
  • func WithHttpClientTimeout(t time.Duration) Option
  • func WithHttpEndpoint(e *url.URL) Option
  • func WithHttpUserAgent(a string) Option
  • func WithIpfsDhtCascade(b bool) Option

Types

type IndexerCandidateFinder

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

func NewCandidateFinder

func NewCandidateFinder(o ...Option) (*IndexerCandidateFinder, error)

func (*IndexerCandidateFinder) FindCandidates

func (idxf *IndexerCandidateFinder) FindCandidates(ctx context.Context, cid cid.Cid) ([]types.RetrievalCandidate, error)

func (*IndexerCandidateFinder) FindCandidatesAsync

func (idxf *IndexerCandidateFinder) FindCandidatesAsync(ctx context.Context, c cid.Cid) (<-chan types.FindCandidatesResult, error)

type Option

type Option func(*options) error

func WithAsyncResultsChanBuffer

func WithAsyncResultsChanBuffer(i int) Option

WithAsyncResultsChanBuffer sets the channel buffer returned by IndexerCandidateFinder.FindCandidatesAsync. Defaults to 1 if unspecified.

func WithHttpClient

func WithHttpClient(c *http.Client) Option

WithHttpClient sets the http.Client used to contact the indexer. Defaults to http.DefaultClient if unspecified.

func WithHttpClientTimeout

func WithHttpClientTimeout(t time.Duration) Option

WithHttpClientTimeout sets the timeout for the HTTP requests sent to the indexer. Defaults to one minute if unspecified.

func WithHttpEndpoint

func WithHttpEndpoint(e *url.URL) Option

WithHttpEndpoint sets the indexer HTTP API endpoint. Defaults to https://cid.contact if unspecified.

func WithHttpUserAgent

func WithHttpUserAgent(a string) Option

WithHttpUserAgent sets the User-Agent header value when contacting the indexer HTTP API. Setting this option to empty string will disable inclusion of User-Agent header. Defaults to "lassie" if unspecified.

func WithIpfsDhtCascade

func WithIpfsDhtCascade(b bool) Option

WithIpfsDhtCascade sets weather to cascade lookups onto the IPFS DHT. Enabled by default if unspecified.