types

package
v1.12.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 20, 2026 License: Apache-2.0, MIT Imports: 17 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrKeyNotFound = errors.New("key not found")

ErrKeyNotFound means the key did not exist in the cache

View Source 
var ErrNoRootBlock = errors.New("query root block not found in car")

ErrNoRootBlock indicates a root that is specified but not found in a CAR file

View Source 
var ErrWrongRootCount = errors.New("query result should have exactly one root")

ErrWrongRootCount indicates a car file with multiple roots being unable to interpret as a query result

Functions

This section is empty.

Types

type BatchingValueSetCache added in v0.10.4 

type BatchingValueSetCache[Key, Value any] interface {
	ValueSetCache[Key, Value]
	Batch() ValueSetCacheBatcher[Key, Value]
}

BatchingValueSetCache is a value-set cache that can batch updates. Note: a batch is not a transaction.

type Cache 

type Cache[Key, Value any] interface {
	Set(ctx context.Context, key Key, value Value, expires bool) error
	SetExpirable(ctx context.Context, key Key, expires bool) error
	Get(ctx context.Context, key Key) (Value, error)
}

Cache describes a generic cache interface

type ContentClaimsCache added in v0.10.4 

type ContentClaimsCache Cache[cid.Cid, delegation.Delegation]

ContentClaimsCache caches fetched content claims

type ContentClaimsStore 

type ContentClaimsStore Store[ipld.Link, delegation.Delegation]

ContentClaimsStore stores published content claims

type ContextID 

type ContextID struct {
	Space *did.DID
	Hash  mh.Multihash
}

ContextID describes the data used to calculate a context id for IPNI

func (ContextID) ToEncoded 

func (c ContextID) ToEncoded() (EncodedContextID, error)

ToEncoded canonically encodes ContextID data

type EncodedContextID 

type EncodedContextID []byte

EncodedContextID is the encoded form of context id data that is actually stored in IPNI

type Getter added in v0.10.4 

type Getter interface {
	// Get retrieves a claim that has been published or cached by the
	// indexing service. No external sources are consulted.
	Get(ctx context.Context, claim ipld.Link) (delegation.Delegation, error)
}

type Match added in v0.10.4 

type Match struct {
	Subject []did.DID
}

Match narrows parameters for locating providers/claims for a set of multihashes

type MockContentClaimsCache added in v0.10.4 

type MockContentClaimsCache struct {
	mock.Mock
}

MockContentClaimsCache is an autogenerated mock type for the ContentClaimsCache type

func NewMockContentClaimsCache added in v0.10.4 

func NewMockContentClaimsCache(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockContentClaimsCache

NewMockContentClaimsCache creates a new instance of MockContentClaimsCache. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockContentClaimsCache) EXPECT added in v0.10.4 

func (_m *MockContentClaimsCache) EXPECT() *MockContentClaimsCache_Expecter

func (*MockContentClaimsCache) Get added in v0.10.4 

func (_mock *MockContentClaimsCache) Get(ctx context.Context, key cid.Cid) (delegation.Delegation, error)

Get provides a mock function for the type MockContentClaimsCache

func (*MockContentClaimsCache) Set added in v0.10.4 

func (_mock *MockContentClaimsCache) Set(ctx context.Context, key cid.Cid, value delegation.Delegation, expires bool) error

Set provides a mock function for the type MockContentClaimsCache

func (*MockContentClaimsCache) SetExpirable added in v0.10.4 

func (_mock *MockContentClaimsCache) SetExpirable(ctx context.Context, key cid.Cid, expires bool) error

SetExpirable provides a mock function for the type MockContentClaimsCache

type MockContentClaimsCache_Expecter added in v0.10.4 

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

func (*MockContentClaimsCache_Expecter) Get added in v0.10.4 

func (_e *MockContentClaimsCache_Expecter) Get(ctx interface{}, key interface{}) *MockContentClaimsCache_Get_Call

Get is a helper method to define mock.On call

  • ctx context.Context
  • key cid.Cid

func (*MockContentClaimsCache_Expecter) Set added in v0.10.4 

func (_e *MockContentClaimsCache_Expecter) Set(ctx interface{}, key interface{}, value interface{}, expires interface{}) *MockContentClaimsCache_Set_Call

Set is a helper method to define mock.On call

  • ctx context.Context
  • key cid.Cid
  • value delegation.Delegation
  • expires bool

func (*MockContentClaimsCache_Expecter) SetExpirable added in v0.10.4 

func (_e *MockContentClaimsCache_Expecter) SetExpirable(ctx interface{}, key interface{}, expires interface{}) *MockContentClaimsCache_SetExpirable_Call

SetExpirable is a helper method to define mock.On call

  • ctx context.Context
  • key cid.Cid
  • expires bool

type MockContentClaimsCache_Get_Call added in v0.10.4 

type MockContentClaimsCache_Get_Call struct {
	*mock.Call
}

MockContentClaimsCache_Get_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Get'

func (*MockContentClaimsCache_Get_Call) Return added in v0.10.4 

func (_c *MockContentClaimsCache_Get_Call) Return(delegation1 delegation.Delegation, err error) *MockContentClaimsCache_Get_Call

func (*MockContentClaimsCache_Get_Call) Run added in v0.10.4 

func (_c *MockContentClaimsCache_Get_Call) Run(run func(ctx context.Context, key cid.Cid)) *MockContentClaimsCache_Get_Call

func (*MockContentClaimsCache_Get_Call) RunAndReturn added in v0.10.4 

func (_c *MockContentClaimsCache_Get_Call) RunAndReturn(run func(ctx context.Context, key cid.Cid) (delegation.Delegation, error)) *MockContentClaimsCache_Get_Call

type MockContentClaimsCache_SetExpirable_Call added in v0.10.4 

type MockContentClaimsCache_SetExpirable_Call struct {
	*mock.Call
}

MockContentClaimsCache_SetExpirable_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'SetExpirable'

func (*MockContentClaimsCache_SetExpirable_Call) Return added in v0.10.4 

func (_c *MockContentClaimsCache_SetExpirable_Call) Return(err error) *MockContentClaimsCache_SetExpirable_Call

func (*MockContentClaimsCache_SetExpirable_Call) Run added in v0.10.4 

func (_c *MockContentClaimsCache_SetExpirable_Call) Run(run func(ctx context.Context, key cid.Cid, expires bool)) *MockContentClaimsCache_SetExpirable_Call

func (*MockContentClaimsCache_SetExpirable_Call) RunAndReturn added in v0.10.4 

func (_c *MockContentClaimsCache_SetExpirable_Call) RunAndReturn(run func(ctx context.Context, key cid.Cid, expires bool) error) *MockContentClaimsCache_SetExpirable_Call

type MockContentClaimsCache_Set_Call added in v0.10.4 

type MockContentClaimsCache_Set_Call struct {
	*mock.Call
}

MockContentClaimsCache_Set_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Set'

func (*MockContentClaimsCache_Set_Call) Return added in v0.10.4 

func (_c *MockContentClaimsCache_Set_Call) Return(err error) *MockContentClaimsCache_Set_Call

func (*MockContentClaimsCache_Set_Call) Run added in v0.10.4 

func (_c *MockContentClaimsCache_Set_Call) Run(run func(ctx context.Context, key cid.Cid, value delegation.Delegation, expires bool)) *MockContentClaimsCache_Set_Call

func (*MockContentClaimsCache_Set_Call) RunAndReturn added in v0.10.4 

func (_c *MockContentClaimsCache_Set_Call) RunAndReturn(run func(ctx context.Context, key cid.Cid, value delegation.Delegation, expires bool) error) *MockContentClaimsCache_Set_Call

type MockContentClaimsStore added in v0.10.4 

type MockContentClaimsStore struct {
	mock.Mock
}

MockContentClaimsStore is an autogenerated mock type for the ContentClaimsStore type

func NewMockContentClaimsStore added in v0.10.4 

func NewMockContentClaimsStore(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockContentClaimsStore

NewMockContentClaimsStore creates a new instance of MockContentClaimsStore. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockContentClaimsStore) EXPECT added in v0.10.4 

func (_m *MockContentClaimsStore) EXPECT() *MockContentClaimsStore_Expecter

func (*MockContentClaimsStore) Get added in v0.10.4 

func (_mock *MockContentClaimsStore) Get(ctx context.Context, key ipld.Link) (delegation.Delegation, error)

Get provides a mock function for the type MockContentClaimsStore

func (*MockContentClaimsStore) Put added in v0.10.4 

func (_mock *MockContentClaimsStore) Put(ctx context.Context, key ipld.Link, value delegation.Delegation) error

Put provides a mock function for the type MockContentClaimsStore

type MockContentClaimsStore_Expecter added in v0.10.4 

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

func (*MockContentClaimsStore_Expecter) Get added in v0.10.4 

func (_e *MockContentClaimsStore_Expecter) Get(ctx interface{}, key interface{}) *MockContentClaimsStore_Get_Call

Get is a helper method to define mock.On call

  • ctx context.Context
  • key ipld.Link

func (*MockContentClaimsStore_Expecter) Put added in v0.10.4 

func (_e *MockContentClaimsStore_Expecter) Put(ctx interface{}, key interface{}, value interface{}) *MockContentClaimsStore_Put_Call

Put is a helper method to define mock.On call

  • ctx context.Context
  • key ipld.Link
  • value delegation.Delegation

type MockContentClaimsStore_Get_Call added in v0.10.4 

type MockContentClaimsStore_Get_Call struct {
	*mock.Call
}

MockContentClaimsStore_Get_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Get'

func (*MockContentClaimsStore_Get_Call) Return added in v0.10.4 

func (_c *MockContentClaimsStore_Get_Call) Return(delegation1 delegation.Delegation, err error) *MockContentClaimsStore_Get_Call

func (*MockContentClaimsStore_Get_Call) Run added in v0.10.4 

func (_c *MockContentClaimsStore_Get_Call) Run(run func(ctx context.Context, key ipld.Link)) *MockContentClaimsStore_Get_Call

func (*MockContentClaimsStore_Get_Call) RunAndReturn added in v0.10.4 

func (_c *MockContentClaimsStore_Get_Call) RunAndReturn(run func(ctx context.Context, key ipld.Link) (delegation.Delegation, error)) *MockContentClaimsStore_Get_Call

type MockContentClaimsStore_Put_Call added in v0.10.4 

type MockContentClaimsStore_Put_Call struct {
	*mock.Call
}

MockContentClaimsStore_Put_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Put'

func (*MockContentClaimsStore_Put_Call) Return added in v0.10.4 

func (_c *MockContentClaimsStore_Put_Call) Return(err error) *MockContentClaimsStore_Put_Call

func (*MockContentClaimsStore_Put_Call) Run added in v0.10.4 

func (_c *MockContentClaimsStore_Put_Call) Run(run func(ctx context.Context, key ipld.Link, value delegation.Delegation)) *MockContentClaimsStore_Put_Call

func (*MockContentClaimsStore_Put_Call) RunAndReturn added in v0.10.4 

func (_c *MockContentClaimsStore_Put_Call) RunAndReturn(run func(ctx context.Context, key ipld.Link, value delegation.Delegation) error) *MockContentClaimsStore_Put_Call

type MockNoProviderStore added in v0.10.4 

type MockNoProviderStore struct {
	mock.Mock
}

MockNoProviderStore is an autogenerated mock type for the NoProviderStore type

func NewMockNoProviderStore added in v0.10.4 

func NewMockNoProviderStore(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockNoProviderStore

NewMockNoProviderStore creates a new instance of MockNoProviderStore. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockNoProviderStore) Add added in v0.10.4 

func (_mock *MockNoProviderStore) Add(ctx context.Context, key multihash.Multihash, values ...multicodec.Code) (uint64, error)

Add provides a mock function for the type MockNoProviderStore

func (*MockNoProviderStore) EXPECT added in v0.10.4 

func (_m *MockNoProviderStore) EXPECT() *MockNoProviderStore_Expecter

func (*MockNoProviderStore) Members added in v0.10.4 

func (_mock *MockNoProviderStore) Members(ctx context.Context, key multihash.Multihash) ([]multicodec.Code, error)

Members provides a mock function for the type MockNoProviderStore

func (*MockNoProviderStore) SetExpirable added in v0.10.4 

func (_mock *MockNoProviderStore) SetExpirable(ctx context.Context, key multihash.Multihash, expires bool) error

SetExpirable provides a mock function for the type MockNoProviderStore

type MockNoProviderStore_Add_Call added in v0.10.4 

type MockNoProviderStore_Add_Call struct {
	*mock.Call
}

MockNoProviderStore_Add_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Add'

func (*MockNoProviderStore_Add_Call) Return added in v0.10.4 

func (_c *MockNoProviderStore_Add_Call) Return(v uint64, err error) *MockNoProviderStore_Add_Call

func (*MockNoProviderStore_Add_Call) Run added in v0.10.4 

func (_c *MockNoProviderStore_Add_Call) Run(run func(ctx context.Context, key multihash.Multihash, values ...multicodec.Code)) *MockNoProviderStore_Add_Call

func (*MockNoProviderStore_Add_Call) RunAndReturn added in v0.10.4 

func (_c *MockNoProviderStore_Add_Call) RunAndReturn(run func(ctx context.Context, key multihash.Multihash, values ...multicodec.Code) (uint64, error)) *MockNoProviderStore_Add_Call

type MockNoProviderStore_Expecter added in v0.10.4 

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

func (*MockNoProviderStore_Expecter) Add added in v0.10.4 

func (_e *MockNoProviderStore_Expecter) Add(ctx interface{}, key interface{}, values ...interface{}) *MockNoProviderStore_Add_Call

Add is a helper method to define mock.On call

  • ctx context.Context
  • key multihash.Multihash
  • values ...multicodec.Code

func (*MockNoProviderStore_Expecter) Members added in v0.10.4 

func (_e *MockNoProviderStore_Expecter) Members(ctx interface{}, key interface{}) *MockNoProviderStore_Members_Call

Members is a helper method to define mock.On call

  • ctx context.Context
  • key multihash.Multihash

func (*MockNoProviderStore_Expecter) SetExpirable added in v0.10.4 

func (_e *MockNoProviderStore_Expecter) SetExpirable(ctx interface{}, key interface{}, expires interface{}) *MockNoProviderStore_SetExpirable_Call

SetExpirable is a helper method to define mock.On call

  • ctx context.Context
  • key multihash.Multihash
  • expires bool

type MockNoProviderStore_Members_Call added in v0.10.4 

type MockNoProviderStore_Members_Call struct {
	*mock.Call
}

MockNoProviderStore_Members_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Members'

func (*MockNoProviderStore_Members_Call) Return added in v0.10.4 

func (_c *MockNoProviderStore_Members_Call) Return(codes []multicodec.Code, err error) *MockNoProviderStore_Members_Call

func (*MockNoProviderStore_Members_Call) Run added in v0.10.4 

func (_c *MockNoProviderStore_Members_Call) Run(run func(ctx context.Context, key multihash.Multihash)) *MockNoProviderStore_Members_Call

func (*MockNoProviderStore_Members_Call) RunAndReturn added in v0.10.4 

func (_c *MockNoProviderStore_Members_Call) RunAndReturn(run func(ctx context.Context, key multihash.Multihash) ([]multicodec.Code, error)) *MockNoProviderStore_Members_Call

type MockNoProviderStore_SetExpirable_Call added in v0.10.4 

type MockNoProviderStore_SetExpirable_Call struct {
	*mock.Call
}

MockNoProviderStore_SetExpirable_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'SetExpirable'

func (*MockNoProviderStore_SetExpirable_Call) Return added in v0.10.4 

func (_c *MockNoProviderStore_SetExpirable_Call) Return(err error) *MockNoProviderStore_SetExpirable_Call

func (*MockNoProviderStore_SetExpirable_Call) Run added in v0.10.4 

func (_c *MockNoProviderStore_SetExpirable_Call) Run(run func(ctx context.Context, key multihash.Multihash, expires bool)) *MockNoProviderStore_SetExpirable_Call

func (*MockNoProviderStore_SetExpirable_Call) RunAndReturn added in v0.10.4 

func (_c *MockNoProviderStore_SetExpirable_Call) RunAndReturn(run func(ctx context.Context, key multihash.Multihash, expires bool) error) *MockNoProviderStore_SetExpirable_Call

type MockProviderStore added in v0.10.4 

type MockProviderStore struct {
	mock.Mock
}

MockProviderStore is an autogenerated mock type for the ProviderStore type

func NewMockProviderStore added in v0.10.4 

func NewMockProviderStore(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockProviderStore

NewMockProviderStore creates a new instance of MockProviderStore. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockProviderStore) Add added in v0.10.4 

func (_mock *MockProviderStore) Add(ctx context.Context, key multihash.Multihash, values ...model.ProviderResult) (uint64, error)

Add provides a mock function for the type MockProviderStore

func (*MockProviderStore) Batch added in v0.10.4 

func (_mock *MockProviderStore) Batch() ValueSetCacheBatcher[multihash.Multihash, model.ProviderResult]

Batch provides a mock function for the type MockProviderStore

func (*MockProviderStore) EXPECT added in v0.10.4 

func (_m *MockProviderStore) EXPECT() *MockProviderStore_Expecter

func (*MockProviderStore) Members added in v0.10.4 

func (_mock *MockProviderStore) Members(ctx context.Context, key multihash.Multihash) ([]model.ProviderResult, error)

Members provides a mock function for the type MockProviderStore

func (*MockProviderStore) SetExpirable added in v0.10.4 

func (_mock *MockProviderStore) SetExpirable(ctx context.Context, key multihash.Multihash, expires bool) error

SetExpirable provides a mock function for the type MockProviderStore

type MockProviderStore_Add_Call added in v0.10.4 

type MockProviderStore_Add_Call struct {
	*mock.Call
}

MockProviderStore_Add_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Add'

func (*MockProviderStore_Add_Call) Return added in v0.10.4 

func (_c *MockProviderStore_Add_Call) Return(v uint64, err error) *MockProviderStore_Add_Call

func (*MockProviderStore_Add_Call) Run added in v0.10.4 

func (_c *MockProviderStore_Add_Call) Run(run func(ctx context.Context, key multihash.Multihash, values ...model.ProviderResult)) *MockProviderStore_Add_Call

func (*MockProviderStore_Add_Call) RunAndReturn added in v0.10.4 

func (_c *MockProviderStore_Add_Call) RunAndReturn(run func(ctx context.Context, key multihash.Multihash, values ...model.ProviderResult) (uint64, error)) *MockProviderStore_Add_Call

type MockProviderStore_Batch_Call added in v0.10.4 

type MockProviderStore_Batch_Call struct {
	*mock.Call
}

MockProviderStore_Batch_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Batch'

func (*MockProviderStore_Batch_Call) Return added in v0.10.4 

func (_c *MockProviderStore_Batch_Call) Return(valueSetCacheBatcher ValueSetCacheBatcher[multihash.Multihash, model.ProviderResult]) *MockProviderStore_Batch_Call

func (*MockProviderStore_Batch_Call) Run added in v0.10.4 

func (_c *MockProviderStore_Batch_Call) Run(run func()) *MockProviderStore_Batch_Call

func (*MockProviderStore_Batch_Call) RunAndReturn added in v0.10.4 

func (_c *MockProviderStore_Batch_Call) RunAndReturn(run func() ValueSetCacheBatcher[multihash.Multihash, model.ProviderResult]) *MockProviderStore_Batch_Call

type MockProviderStore_Expecter added in v0.10.4 

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

func (*MockProviderStore_Expecter) Add added in v0.10.4 

func (_e *MockProviderStore_Expecter) Add(ctx interface{}, key interface{}, values ...interface{}) *MockProviderStore_Add_Call

Add is a helper method to define mock.On call

  • ctx context.Context
  • key multihash.Multihash
  • values ...model.ProviderResult

func (*MockProviderStore_Expecter) Batch added in v0.10.4 

func (_e *MockProviderStore_Expecter) Batch() *MockProviderStore_Batch_Call

Batch is a helper method to define mock.On call

func (*MockProviderStore_Expecter) Members added in v0.10.4 

func (_e *MockProviderStore_Expecter) Members(ctx interface{}, key interface{}) *MockProviderStore_Members_Call

Members is a helper method to define mock.On call

  • ctx context.Context
  • key multihash.Multihash

func (*MockProviderStore_Expecter) SetExpirable added in v0.10.4 

func (_e *MockProviderStore_Expecter) SetExpirable(ctx interface{}, key interface{}, expires interface{}) *MockProviderStore_SetExpirable_Call

SetExpirable is a helper method to define mock.On call

  • ctx context.Context
  • key multihash.Multihash
  • expires bool

type MockProviderStore_Members_Call added in v0.10.4 

type MockProviderStore_Members_Call struct {
	*mock.Call
}

MockProviderStore_Members_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Members'

func (*MockProviderStore_Members_Call) Return added in v0.10.4 

func (_c *MockProviderStore_Members_Call) Return(providerResults []model.ProviderResult, err error) *MockProviderStore_Members_Call

func (*MockProviderStore_Members_Call) Run added in v0.10.4 

func (_c *MockProviderStore_Members_Call) Run(run func(ctx context.Context, key multihash.Multihash)) *MockProviderStore_Members_Call

func (*MockProviderStore_Members_Call) RunAndReturn added in v0.10.4 

func (_c *MockProviderStore_Members_Call) RunAndReturn(run func(ctx context.Context, key multihash.Multihash) ([]model.ProviderResult, error)) *MockProviderStore_Members_Call

type MockProviderStore_SetExpirable_Call added in v0.10.4 

type MockProviderStore_SetExpirable_Call struct {
	*mock.Call
}

MockProviderStore_SetExpirable_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'SetExpirable'

func (*MockProviderStore_SetExpirable_Call) Return added in v0.10.4 

func (_c *MockProviderStore_SetExpirable_Call) Return(err error) *MockProviderStore_SetExpirable_Call

func (*MockProviderStore_SetExpirable_Call) Run added in v0.10.4 

func (_c *MockProviderStore_SetExpirable_Call) Run(run func(ctx context.Context, key multihash.Multihash, expires bool)) *MockProviderStore_SetExpirable_Call

func (*MockProviderStore_SetExpirable_Call) RunAndReturn added in v0.10.4 

func (_c *MockProviderStore_SetExpirable_Call) RunAndReturn(run func(ctx context.Context, key multihash.Multihash, expires bool) error) *MockProviderStore_SetExpirable_Call

type MockService added in v0.10.4 

type MockService struct {
	mock.Mock
}

MockService is an autogenerated mock type for the Service type

func NewMockService added in v0.10.4 

func NewMockService(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockService

NewMockService creates a new instance of MockService. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockService) Cache added in v0.10.4 

func (_mock *MockService) Cache(ctx context.Context, provider peer.AddrInfo, claim delegation.Delegation) error

Cache provides a mock function for the type MockService

func (*MockService) EXPECT added in v0.10.4 

func (_m *MockService) EXPECT() *MockService_Expecter

func (*MockService) Get added in v0.10.4 

func (_mock *MockService) Get(ctx context.Context, claim ipld.Link) (delegation.Delegation, error)

Get provides a mock function for the type MockService

func (*MockService) Publish added in v0.10.4 

func (_mock *MockService) Publish(ctx context.Context, claim delegation.Delegation) error

Publish provides a mock function for the type MockService

func (*MockService) Query added in v0.10.4 

func (_mock *MockService) Query(ctx context.Context, q Query) (QueryResult, error)

Query provides a mock function for the type MockService

type MockService_Cache_Call added in v0.10.4 

type MockService_Cache_Call struct {
	*mock.Call
}

MockService_Cache_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Cache'

func (*MockService_Cache_Call) Return added in v0.10.4 

func (_c *MockService_Cache_Call) Return(err error) *MockService_Cache_Call

func (*MockService_Cache_Call) Run added in v0.10.4 

func (_c *MockService_Cache_Call) Run(run func(ctx context.Context, provider peer.AddrInfo, claim delegation.Delegation)) *MockService_Cache_Call

func (*MockService_Cache_Call) RunAndReturn added in v0.10.4 

func (_c *MockService_Cache_Call) RunAndReturn(run func(ctx context.Context, provider peer.AddrInfo, claim delegation.Delegation) error) *MockService_Cache_Call

type MockService_Expecter added in v0.10.4 

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

func (*MockService_Expecter) Cache added in v0.10.4 

func (_e *MockService_Expecter) Cache(ctx interface{}, provider interface{}, claim interface{}) *MockService_Cache_Call

Cache is a helper method to define mock.On call

  • ctx context.Context
  • provider peer.AddrInfo
  • claim delegation.Delegation

func (*MockService_Expecter) Get added in v0.10.4 

func (_e *MockService_Expecter) Get(ctx interface{}, claim interface{}) *MockService_Get_Call

Get is a helper method to define mock.On call

  • ctx context.Context
  • claim ipld.Link

func (*MockService_Expecter) Publish added in v0.10.4 

func (_e *MockService_Expecter) Publish(ctx interface{}, claim interface{}) *MockService_Publish_Call

Publish is a helper method to define mock.On call

  • ctx context.Context
  • claim delegation.Delegation

func (*MockService_Expecter) Query added in v0.10.4 

func (_e *MockService_Expecter) Query(ctx interface{}, q interface{}) *MockService_Query_Call

Query is a helper method to define mock.On call

  • ctx context.Context
  • q Query

type MockService_Get_Call added in v0.10.4 

type MockService_Get_Call struct {
	*mock.Call
}

MockService_Get_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Get'

func (*MockService_Get_Call) Return added in v0.10.4 

func (_c *MockService_Get_Call) Return(delegation1 delegation.Delegation, err error) *MockService_Get_Call

func (*MockService_Get_Call) Run added in v0.10.4 

func (_c *MockService_Get_Call) Run(run func(ctx context.Context, claim ipld.Link)) *MockService_Get_Call

func (*MockService_Get_Call) RunAndReturn added in v0.10.4 

func (_c *MockService_Get_Call) RunAndReturn(run func(ctx context.Context, claim ipld.Link) (delegation.Delegation, error)) *MockService_Get_Call

type MockService_Publish_Call added in v0.10.4 

type MockService_Publish_Call struct {
	*mock.Call
}

MockService_Publish_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Publish'

func (*MockService_Publish_Call) Return added in v0.10.4 

func (_c *MockService_Publish_Call) Return(err error) *MockService_Publish_Call

func (*MockService_Publish_Call) Run added in v0.10.4 

func (_c *MockService_Publish_Call) Run(run func(ctx context.Context, claim delegation.Delegation)) *MockService_Publish_Call

func (*MockService_Publish_Call) RunAndReturn added in v0.10.4 

func (_c *MockService_Publish_Call) RunAndReturn(run func(ctx context.Context, claim delegation.Delegation) error) *MockService_Publish_Call

type MockService_Query_Call added in v0.10.4 

type MockService_Query_Call struct {
	*mock.Call
}

MockService_Query_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Query'

func (*MockService_Query_Call) Return added in v0.10.4 

func (_c *MockService_Query_Call) Return(queryResult QueryResult, err error) *MockService_Query_Call

func (*MockService_Query_Call) Run added in v0.10.4 

func (_c *MockService_Query_Call) Run(run func(ctx context.Context, q Query)) *MockService_Query_Call

func (*MockService_Query_Call) RunAndReturn added in v0.10.4 

func (_c *MockService_Query_Call) RunAndReturn(run func(ctx context.Context, q Query) (QueryResult, error)) *MockService_Query_Call

type MockValueSetCacheBatcher added in v0.10.4 

type MockValueSetCacheBatcher[Key any, Value any] struct {
	mock.Mock
}

MockValueSetCacheBatcher is an autogenerated mock type for the ValueSetCacheBatcher type

func NewMockValueSetCacheBatcher added in v0.10.4 

func NewMockValueSetCacheBatcher[Key any, Value any](t interface {
	mock.TestingT
	Cleanup(func())
}) *MockValueSetCacheBatcher[Key, Value]

NewMockValueSetCacheBatcher creates a new instance of MockValueSetCacheBatcher. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockValueSetCacheBatcher[Key, Value]) Add added in v0.10.4 

func (_mock *MockValueSetCacheBatcher[Key, Value]) Add(ctx context.Context, key Key, values ...Value) error

Add provides a mock function for the type MockValueSetCacheBatcher

func (*MockValueSetCacheBatcher[Key, Value]) Commit added in v0.10.4 

func (_mock *MockValueSetCacheBatcher[Key, Value]) Commit(ctx context.Context) error

Commit provides a mock function for the type MockValueSetCacheBatcher

func (*MockValueSetCacheBatcher[Key, Value]) EXPECT added in v0.10.4 

func (_m *MockValueSetCacheBatcher[Key, Value]) EXPECT() *MockValueSetCacheBatcher_Expecter[Key, Value]

func (*MockValueSetCacheBatcher[Key, Value]) SetExpirable added in v0.10.4 

func (_mock *MockValueSetCacheBatcher[Key, Value]) SetExpirable(ctx context.Context, key Key, expires bool) error

SetExpirable provides a mock function for the type MockValueSetCacheBatcher

type MockValueSetCacheBatcher_Add_Call added in v0.10.4 

type MockValueSetCacheBatcher_Add_Call[Key any, Value any] struct {
	*mock.Call
}

MockValueSetCacheBatcher_Add_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Add'

func (*MockValueSetCacheBatcher_Add_Call[Key, Value]) Return added in v0.10.4 

func (_c *MockValueSetCacheBatcher_Add_Call[Key, Value]) Return(err error) *MockValueSetCacheBatcher_Add_Call[Key, Value]

func (*MockValueSetCacheBatcher_Add_Call[Key, Value]) Run added in v0.10.4 

func (_c *MockValueSetCacheBatcher_Add_Call[Key, Value]) Run(run func(ctx context.Context, key Key, values ...Value)) *MockValueSetCacheBatcher_Add_Call[Key, Value]

func (*MockValueSetCacheBatcher_Add_Call[Key, Value]) RunAndReturn added in v0.10.4 

func (_c *MockValueSetCacheBatcher_Add_Call[Key, Value]) RunAndReturn(run func(ctx context.Context, key Key, values ...Value) error) *MockValueSetCacheBatcher_Add_Call[Key, Value]

type MockValueSetCacheBatcher_Commit_Call added in v0.10.4 

type MockValueSetCacheBatcher_Commit_Call[Key any, Value any] struct {
	*mock.Call
}

MockValueSetCacheBatcher_Commit_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Commit'

func (*MockValueSetCacheBatcher_Commit_Call[Key, Value]) Return added in v0.10.4 

func (_c *MockValueSetCacheBatcher_Commit_Call[Key, Value]) Return(err error) *MockValueSetCacheBatcher_Commit_Call[Key, Value]

func (*MockValueSetCacheBatcher_Commit_Call[Key, Value]) Run added in v0.10.4 

func (_c *MockValueSetCacheBatcher_Commit_Call[Key, Value]) Run(run func(ctx context.Context)) *MockValueSetCacheBatcher_Commit_Call[Key, Value]

func (*MockValueSetCacheBatcher_Commit_Call[Key, Value]) RunAndReturn added in v0.10.4 

func (_c *MockValueSetCacheBatcher_Commit_Call[Key, Value]) RunAndReturn(run func(ctx context.Context) error) *MockValueSetCacheBatcher_Commit_Call[Key, Value]

type MockValueSetCacheBatcher_Expecter added in v0.10.4 

type MockValueSetCacheBatcher_Expecter[Key any, Value any] struct {
	// contains filtered or unexported fields
}

func (*MockValueSetCacheBatcher_Expecter[Key, Value]) Add added in v0.10.4 

func (_e *MockValueSetCacheBatcher_Expecter[Key, Value]) Add(ctx interface{}, key interface{}, values ...interface{}) *MockValueSetCacheBatcher_Add_Call[Key, Value]

Add is a helper method to define mock.On call

  • ctx context.Context
  • key Key
  • values ...Value

func (*MockValueSetCacheBatcher_Expecter[Key, Value]) Commit added in v0.10.4 

func (_e *MockValueSetCacheBatcher_Expecter[Key, Value]) Commit(ctx interface{}) *MockValueSetCacheBatcher_Commit_Call[Key, Value]

Commit is a helper method to define mock.On call

  • ctx context.Context

func (*MockValueSetCacheBatcher_Expecter[Key, Value]) SetExpirable added in v0.10.4 

func (_e *MockValueSetCacheBatcher_Expecter[Key, Value]) SetExpirable(ctx interface{}, key interface{}, expires interface{}) *MockValueSetCacheBatcher_SetExpirable_Call[Key, Value]

SetExpirable is a helper method to define mock.On call

  • ctx context.Context
  • key Key
  • expires bool

type MockValueSetCacheBatcher_SetExpirable_Call added in v0.10.4 

type MockValueSetCacheBatcher_SetExpirable_Call[Key any, Value any] struct {
	*mock.Call
}

MockValueSetCacheBatcher_SetExpirable_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'SetExpirable'

func (*MockValueSetCacheBatcher_SetExpirable_Call[Key, Value]) Return added in v0.10.4 

func (_c *MockValueSetCacheBatcher_SetExpirable_Call[Key, Value]) Return(err error) *MockValueSetCacheBatcher_SetExpirable_Call[Key, Value]

func (*MockValueSetCacheBatcher_SetExpirable_Call[Key, Value]) Run added in v0.10.4 

func (_c *MockValueSetCacheBatcher_SetExpirable_Call[Key, Value]) Run(run func(ctx context.Context, key Key, expires bool)) *MockValueSetCacheBatcher_SetExpirable_Call[Key, Value]

func (*MockValueSetCacheBatcher_SetExpirable_Call[Key, Value]) RunAndReturn added in v0.10.4 

func (_c *MockValueSetCacheBatcher_SetExpirable_Call[Key, Value]) RunAndReturn(run func(ctx context.Context, key Key, expires bool) error) *MockValueSetCacheBatcher_SetExpirable_Call[Key, Value]

type NoProviderStore added in v0.10.4 

type NoProviderStore ValueSetCache[mh.Multihash, multicodec.Code]

NoProviderStore caches which queries for providers returned no results

type ProviderStore 

type ProviderStore BatchingValueSetCache[mh.Multihash, model.ProviderResult]

ProviderStore caches queries to IPNI

type Publisher added in v0.10.4 

type Publisher interface {
	// Cache caches a claim with the service temporarily.
	Cache(ctx context.Context, provider peer.AddrInfo, claim delegation.Delegation) error
	// Publish writes a claim to permanent storage, adds it to an IPNI
	// advertisement, annnounces it to IPNI nodes and caches it.
	Publish(ctx context.Context, claim delegation.Delegation) error
}

type Querier added in v0.10.4 

type Querier interface {
	// Query allows claims to be queried by their subject (content CID). It
	// returns claims as well as any relevant indexes.
	Query(ctx context.Context, q Query) (QueryResult, error)
}

type Query added in v0.10.4 

type Query struct {
	Type   QueryType
	Hashes []mh.Multihash
	Match  Match
	// Delegations allowing the indexer to retrieve bytes from the network. These
	// are typically `space/content/retrieve` delegations for each subject (space)
	// in the [Match] paremeter.
	//
	// Delegations are sent in the `X-Agent-Message` HTTP header and MUST NOT
	// exceed 4kb in size.
	Delegations []delegation.Delegation
}

Query is a query for several multihashes

type QueryResult added in v0.10.4 

type QueryResult interface {
	ipld.View
	// Claims is a list of links to the root block of claims that can be found in this message
	Claims() []ipld.Link
	// Indexes is a list of links to the CID hash of archived sharded dag indexes that can be found in this
	// message
	Indexes() []ipld.Link
}

QueryResult is an encodable result of a query

type QueryType added in v0.10.4 

type QueryType int

QueryType allows defining which claims a query is targeting. QueryTypeStandard targets all claims, i.e. Location, Index and Equals 

const (
	QueryTypeStandard QueryType = iota
	QueryTypeLocation
	QueryTypeIndexOrLocation
	QueryTypeStandardCompressed
)

func ParseQueryType added in v0.10.4 

func ParseQueryType(queryTypeStr string) (QueryType, error)

func (QueryType) String added in v0.10.4 

func (qt QueryType) String() string

type RetrievalAuth added in v1.10.6 

type RetrievalAuth struct {
	// The Indexing Service UCAN signing key.
	Issuer ucan.Signer
	// Identity of the storage node to retrieve data from.
	Audience ucan.Principal
	// Retrieval ability, resource (typically the space) and caveats.
	Capability ucan.Capability[ucan.CaveatBuilder]
	// Delegations from the client (e.g. `space/content/retrieve`) or a storage
	// node (e.g. `blob/retrieve`) to the indexing service authorizing retrieval.
	Proofs []delegation.Proof
}

RetrievalAuth are the details for a UCAN authorized content retrieval.

The provided proofs are expected to contain the `space/content/retrieve` delegated capability allowing content to be retrieved using UCAN authorization.

func NewRetrievalAuth added in v1.10.6 

func NewRetrievalAuth[C ucan.CaveatBuilder](
	issuer ucan.Signer,
	audience ucan.Principal,
	capability ucan.Capability[C],
	proofs []delegation.Proof,
) RetrievalAuth

NewRetrievalAuth creates a new RetrievalAuth object for UCAN authorizing blob retrievals.

type RetrievalRequest added in v1.10.6 

type RetrievalRequest struct {
	// URL where the blob may be requested from.
	URL *url.URL
	// Optional byte range to request.
	Range *metadata.Range
	// Optional UCAN authorization parameters.
	Auth *RetrievalAuth
}

RetrievalRequest is all the details needed for retrieving data from the network. At minimum it contains the URL to retrieve a blob from.

Legacy retrievals will not carry any retrieval authorization information i.e. the Auth field will be nil.

func NewRetrievalRequest added in v1.10.6 

func NewRetrievalRequest(
	url *url.URL,
	byteRange *metadata.Range,
	auth *RetrievalAuth,
) RetrievalRequest

NewRetrievalRequest creates a new RetrievalRequest object that contains all the details required to retrieve a blob from the network.

type Service added in v0.10.4 

type Service interface {
	Getter
	Publisher
	Querier
}

Service is the core methods of the indexing service.

type ShardedDagIndexStore 

type ShardedDagIndexStore Cache[EncodedContextID, blobindex.ShardedDagIndexView]

ShardedDagIndexStore caches fetched sharded dag indexes

type Store added in v0.10.4 

type Store[Key, Value any] interface {
	// Put adds (or replaces) an item in the store.
	Put(ctx context.Context, key Key, value Value) error
	// Get retrieves an existing item from the store. If the item does not exist,
	// it should return [ErrKeyNotFound].
	Get(ctx context.Context, key Key) (Value, error)
}

Store describes a generic storage interface

type ValueSetCache added in v0.10.4 

type ValueSetCache[Key, Value any] interface {
	Add(ctx context.Context, key Key, values ...Value) (uint64, error)
	SetExpirable(ctx context.Context, key Key, expires bool) error
	Members(ctx context.Context, key Key) ([]Value, error)
}

ValueSetCache describes a cache interface whose values are sets

type ValueSetCacheBatcher added in v0.10.4 

type ValueSetCacheBatcher[Key, Value any] interface {
	Add(ctx context.Context, key Key, values ...Value) error
	SetExpirable(ctx context.Context, key Key, expires bool) error
	Commit(ctx context.Context) error
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.