types

type ErrorCode int

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

type GetResponse[K ResponseKey, V ResponseValue] struct {
	Resolved   map[K]ResolvedResult[V]
	UnResolved map[K]UnresolvedResult
}

type Provider[K ResponseKey, V ResponseValue] interface {
	// Name returns the name of the provider.
	Name() string

	// GetData returns the aggregated data for the given (key, value) pairs.
	// For example, if the provider is fetching prices for a set of currency
	// pairs, the data returned by this function would be the latest prices
	// for those currency pairs.
	GetData() map[K]ResolvedResult[V]

	// Start starts the provider.
	Start(context.Context) error

	// Type returns the type of the provider data handler.
	Type() ProviderType

	// IsRunning returns whether the provider is running.
	IsRunning() bool
}

type ProviderType string

type ResolvedResult[V ResponseValue] struct {
	// Value is the value of the requested ID.
	Value V
	// Timestamp is the timestamp of the value.
	Timestamp time.Time
	// ResponseCode is an optional code that can be attached to responses to provide
	// additional context.
	ResponseCode ResponseCode
}

type ResponseCode int

type ResponseKey interface {
	comparable
	fmt.Stringer
}

type ResponseValue interface {
	fmt.Stringer
}

type UnresolvedResult struct {
	ErrorWithCode
}