types

Jan 27, 2024

Changes in this version

+ type CandidateSource interface

+ FindCandidates func(context.Context, cid.Cid, func(RetrievalCandidate)) error

+ type Provider struct

+ Peer peer.AddrInfo

+ Protocols []metadata.Protocol

type RetrievalRequest

+ Providers []Provider

Oct 2, 2023

Changes in this version

+ func IsUnknownPeerID(p peer.ID) bool

type RetrievalEvent

+ RootCid func() cid.Cid

Sep 19, 2023

Changes in this version

type EventCode

+ const BlockReceivedCode

+ type FetchConfig struct

+ EventsCallback func(RetrievalEvent)

+ func NewFetchConfig(opts ...FetchOption) FetchConfig

+ type FetchOption func(cfg *FetchConfig)

+ func WithEventsCallback(callback func(RetrievalEvent)) FetchOption

Aug 24, 2023

Changes in this version

+ type ByteRange struct

+ From int64

+ To *int64

+ func ParseByteRange(s string) (ByteRange, error)

+ func (br *ByteRange) IsDefault() bool

+ func (br *ByteRange) String() string

type DagScope

+ func ParseDagScope(s string) (DagScope, error)

type RetrievalRequest

+ Bytes *ByteRange

Aug 24, 2023

Changes in this version

+ func PathEscape(path string) string

+ func ToProviderString(ai []peer.AddrInfo) (string, error)

type RetrievalRequest

+ func (r RetrievalRequest) GetDescriptorString() (string, error)

Aug 2, 2023

Changes in this version

+ type Fetcher interface

+ Fetch func(context.Context, RetrievalRequest, func(RetrievalEvent)) (*RetrievalStats, error)

Jul 13, 2023

Changes in this version

type EventCode

+ const ConnectedToProviderCode

+ const FailedRetrievalCode

+ const StartedFetchCode

+ const StartedFindingCandidatesCode

+ const StartedRetrievalCode

Jun 22, 2023

Changes in this version

type RetrievalRequest

+ func (r RetrievalRequest) HasPreloadLinkSystem() bool

Jun 5, 2023

Changes in this version

type RetrievalRequest

+ Duplicates bool

+ func (r RetrievalRequest) Etag() string

May 25, 2023

Changes in this version

+ func PathScopeSelector(path string, scope DagScope) ipld.Node

+ type DagScope string

+ const DagScopeAll

+ const DagScopeBlock

+ const DagScopeEntity

+ func (ds DagScope) AcceptHeader() string

+ func (ds DagScope) TerminalSelectorSpec() builder.SelectorSpec

May 15, 2023

Changes in this version

type CarScope

+ func (cs CarScope) AcceptHeader() string

+ func (cs CarScope) TerminalSelectorSpec() builder.SelectorSpec

type RetrievalCandidate

+ func (rc RetrievalCandidate) ToURL() (*url.URL, error)

type RetrievalRequest

+ Path string

+ Scope CarScope

+ func (r RetrievalRequest) GetUrlPath() (string, error)

May 3, 2023

Changes in this version

+ func ParseProviderStrings(v string) ([]peer.AddrInfo, error)

type RetrievalRequest

+ FixedPeers []peer.AddrInfo

Apr 24, 2023

Changes in this version

type CarScope

+ const CarScopeBlock

type RetrievalRequest

+ MaxBlocks uint64

Apr 7, 2023

Changes in this version

+ type CarScope string

+ const CarScopeAll

+ const CarScopeFile

+ const CarScopeRoot

Mar 31, 2023

Changes in this version

type RetrievalRequest

+ PreloadLinkSystem ipld.LinkSystem

Mar 22, 2023

Changes in this version

+ func ParseProtocolsString(v string) ([]multicodec.Code, error)

type RetrievalRequest

+ Protocols []multicodec.Code

+ func (r RetrievalRequest) GetSupportedProtocols(allSupportedProtocols []multicodec.Code) []multicodec.Code

Mar 15, 2023

Changes in this version

type EventCode

+ const FinishedCode

type Phase

+ const FetchPhase

Mar 3, 2023

Changes in this version

+ func MakeAsyncCandidates(buffer int) (InboundAsyncCandidates, OutboundAsyncCandidates)

+ type AsyncCandidateSplitter interface

+ SplitRetrievalRequest func(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) AsyncRetrievalSplitter[T]

+ type AsyncRetrievalSplitter interface

+ SplitAsyncCandidates func(asyncCandidates InboundAsyncCandidates) (map[T]InboundAsyncCandidates, <-chan error)

+ type AsyncRetrievalTask struct

+ AsyncCandidateRetrieval CandidateRetrieval

+ Candidates InboundAsyncCandidates

+ func (art AsyncRetrievalTask) Run() (*RetrievalStats, error)

type CandidateRetrieval

+ RetrieveFromAsyncCandidates func(asyncCandidates InboundAsyncCandidates) (*RetrievalStats, error)

type CandidateSplitter

+ SplitRetrievalRequest func(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) RetrievalSplitter[T]

+ type DeferredErrorTask struct

+ Ctx context.Context

+ ErrChan <-chan error

+ func (det DeferredErrorTask) Run() (*RetrievalStats, error)

+ type InboundAsyncCandidates <-chan []RetrievalCandidate

+ func (ias InboundAsyncCandidates) Next(ctx context.Context) (bool, []RetrievalCandidate, error)

+ type OutboundAsyncCandidates chan<- []RetrievalCandidate

+ func (oas OutboundAsyncCandidates) SendNext(ctx context.Context, next []RetrievalCandidate) error

+ type QueueRetrievalsFn func(ctx context.Context, nextRetrievalCall func(RetrievalTask))

+ type RetrievalTask interface

+ Run func() (*RetrievalStats, error)

Mar 1, 2023

Changes in this version

+ type ReadableWritableStorage interface

type RetrievalRequest

+ Selector ipld.Node

+ func NewRequestForPath(store ReadableWritableStorage, cid cid.Cid, path string, full bool) (RetrievalRequest, error)

+ func (r RetrievalRequest) GetSelector() ipld.Node

type RetrievalStats

+ Selector string

Feb 20, 2023

Changes in this version

type RetrievalStats

+ TimeToFirstByte time.Duration

Feb 16, 2023

Changes in this version

+ const BitswapIndentifier

+ const RaceCoordination

+ const SequentialCoordination

+ var ErrIncorrectContextValue = errors.New("context key does not point to a valid retrieval id")

+ var ErrMissingContextKey = errors.New("context key for retrieval is missing")

+ func Identifier(event RetrievalEvent) string

+ func QueryResponseFromReader(r io.Reader) (*retrievalmarket.QueryResponse, error)

+ func QueryToWriter(q *retrievalmarket.Query, w io.Writer) error

+ func RegisterRetrievalIDToContext(parentCtx context.Context, id RetrievalID) context.Context

+ type CandidateFinder interface

+ FindCandidates func(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) ([]RetrievalCandidate, error)

+ type CandidateRetrieval interface

+ RetrieveFromCandidates func([]RetrievalCandidate) (*RetrievalStats, error)

+ type CandidateRetrievalCall struct

+ CandidateRetrieval CandidateRetrieval

+ Candidates []RetrievalCandidate

type CandidateRetriever

+ Retrieve func(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) CandidateRetrieval

+ type CandidateSplitter interface

+ SplitRetrieval func(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) RetrievalSplitter

+ type CoordinationKind string

+ type FindCandidatesResult struct

+ Candidate RetrievalCandidate

+ Err error

type RetrievalCandidate

+ Metadata metadata.Metadata

+ type RetrievalCoordinator func(context.Context, []CandidateRetrievalCall) (*RetrievalStats, error)

type RetrievalEvent

+ Protocols func() []multicodec.Code

type RetrievalID

+ func RetrievalIDFromContext(ctx context.Context) (RetrievalID, error)

+ type RetrievalResult struct

+ Err error

+ Stats *RetrievalStats

+ type RetrievalSplitter interface

+ SplitCandidates func([]RetrievalCandidate) ([][]RetrievalCandidate, error)

type Retriever

+ Retrieve func(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) (*RetrievalStats, error)

Feb 3, 2023

Changes in this version

+ type CandidateRetriever func(ctx context.Context, request RetrievalRequest, candidates []RetrievalCandidate, ...) (*RetrievalStats, error)

+ type EventCode string

+ const AcceptedCode

+ const CandidatesFilteredCode

+ const CandidatesFoundCode

+ const ConnectedCode

+ const FailedCode

+ const FirstByteCode

+ const ProposedCode

+ const QueryAskedCode

+ const QueryAskedFilteredCode

+ const StartedCode

+ const SuccessCode

+ type Phase string

+ const IndexerPhase

+ const QueryPhase

+ const RetrievalPhase

+ type RetrievalCandidate struct

+ MinerPeer peer.AddrInfo

+ RootCid cid.Cid

+ func NewRetrievalCandidate(pid peer.ID, rootCid cid.Cid) RetrievalCandidate

+ type RetrievalCandidateFinder func(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) ([]RetrievalCandidate, error)

+ type RetrievalEvent interface

+ Code func() EventCode

+ PayloadCid func() cid.Cid

+ Phase func() Phase

+ PhaseStartTime func() time.Time

+ RetrievalId func() RetrievalID

+ StorageProviderId func() peer.ID

+ Time func() time.Time

+ type RetrievalEventSubscriber func(event RetrievalEvent)

+ type RetrievalID uuid.UUID

+ func NewRetrievalID() (RetrievalID, error)

+ func (id *RetrievalID) UnmarshalText(data []byte) error

+ func (id RetrievalID) MarshalText() ([]byte, error)

+ func (id RetrievalID) String() string

+ type RetrievalRequest struct

+ Cid cid.Cid

+ LinkSystem ipld.LinkSystem

+ RetrievalID RetrievalID

+ type RetrievalStats struct

+ AskPrice abi.TokenAmount

+ AverageSpeed uint64

+ Blocks uint64

+ Duration time.Duration

+ NumPayments int

+ RootCid cid.Cid

+ Size uint64

+ StorageProviderId peer.ID

+ TotalPayment abi.TokenAmount

+ type Retriever func(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) (*RetrievalStats, error)

+ func WithCandidates(retrievalCandidateFinder RetrievalCandidateFinder, ...) Retriever

Jan 13, 2023

Changes in this version

+ const FilecoinPrecision

+ type FIL gostatetypesbig.Int

+ func (f FIL) String() string

+ func (f FIL) Unitless() string