providerfilters

package

v0.0.0-...-ada256f Latest Latest Go to latest Published: May 31, 2023 License: AGPL-3.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type CidFilter struct{}

CidFilter filters out invalid CID's or those which are not Raw or DagProtobuf.

func NewCidFilter() *CidFilter

NewCidFilter returns a pointer to a new CidFilter.

func (f *CidFilter) Filter(p t.Provider) (bool, error)

Filter takes a Provider and returns true when it is to be included, false when not and an error when unexpected condition occur.

type Filter interface {
	Filter(t.Provider) (bool, error)
}

Filter takes a Provider and returns true when it is to be included, false when not and an error when unexpected condition occur.

type LastSeenFilter struct {
	Expiration time.Duration
	PruneLen   int
	// contains filtered or unexported fields
}

LastSeenFilter filters out recently seen Providers.

func NewLastSeenFilter(expiration time.Duration, pruneLen int) *LastSeenFilter

NewLastSeenFilter initialises a new LastSeenFilter and returns a pointer to it.

func (f *LastSeenFilter) Filter(p t.Provider) (bool, error)

Filter takes a Provider and returns true when it is to be included, false when not and an error when unexpected condition occur.

type MockFilter struct {
	Calls int
	R     bool
	Err   error
	P     types.Provider
}

MockFilter represents a mock for a Filter.

func (m *MockFilter) Filter(p types.Provider) (bool, error)

Filter returns the specified mock result and/or error and increments calls.

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

MultiFilter efficiently combines multiple filters into a single filter.

func NewMultiFilter(filters ...Filter) *MultiFilter

NewMultiFilter returns a pointer to a new MultiFilter.

func (m *MultiFilter) Filter(p t.Provider) (bool, error)

Filter takes a Provider and returns true when it is to be included, false when not and an error when unexpected condition occur.