Documentation
¶
Index ¶
- type Client
- type ClientOption
- type ClientOptions
- type DefaultTool
- func (d *DefaultTool) New(ctx context.Context, name string) (any, error)
- func (d *DefaultTool) NewDefault(ctx context.Context, name string) (any, error)
- func (d *DefaultTool) NewPullPayload(ctx context.Context, ressource string) (contract.PLPull, error)
- func (d *DefaultTool) NewPullSession(ctx context.Context, ressource string) (any, error)
- func (d *DefaultTool) NewPullSubFunc(ctx context.Context, ressource string, pullType int) (contract.PullSubFunc, error)
- type DefaultsRegistry
- type PullPair
- type PullSubFuncsRegistry
- type PullToRegister
- type ToRegister
- type Tool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client interface {
contract.FactoryOperator
}
func NewClient ¶
func NewClient(opts ClientOptions) (Client, error)
type ClientOption ¶ added in v0.1.36
type ClientOption func(*ClientOptions)
func WithDefaultsRegistry ¶ added in v0.1.414
func WithDefaultsRegistry(x DefaultsRegistry) ClientOption
func WithPull ¶ added in v0.1.676
func WithPull(x PullToRegister) ClientOption
func WithPullSubFuncs ¶ added in v0.1.676
func WithPullSubFuncs(x PullSubFuncsRegistry) ClientOption
func WithToRegister ¶ added in v0.1.36
func WithToRegister(x ToRegister) ClientOption
type ClientOptions ¶ added in v0.1.36
type ClientOptions struct {
D DefaultsRegistry
T ToRegister
P PullToRegister
PSFn PullSubFuncsRegistry
}
func ApplyClientOptions ¶ added in v0.1.36
func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions
type DefaultTool ¶ added in v0.1.11
func NewTool ¶
func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool
func (*DefaultTool) NewDefault ¶ added in v0.1.414
NewDefault retrieves a pre-registered default instance from the factory.
func (*DefaultTool) NewPullPayload ¶ added in v0.1.676
func (d *DefaultTool) NewPullPayload(ctx context.Context, ressource string) (contract.PLPull, error)
NewPullPayload creates a new pull payload for the given ressource.
func (*DefaultTool) NewPullSession ¶ added in v0.1.676
NewPullSession creates a new pull session for the given ressource.
func (*DefaultTool) NewPullSubFunc ¶ added in v0.1.676
func (d *DefaultTool) NewPullSubFunc(ctx context.Context, ressource string, pullType int) (contract.PullSubFunc, error)
NewPullSubFunc retrieves a registered pull sub function by ressource and type.
type DefaultsRegistry ¶ added in v0.1.414
DefaultsRegistry is a map of collection names to default values, each of which must implement engine.Record.
type PullSubFuncsRegistry ¶ added in v0.1.676
type PullSubFuncsRegistry map[string]map[int]contract.PullSubFunc
type PullToRegister ¶ added in v0.1.676
type ToRegister ¶ added in v0.1.36
Click to show internal directories.
Click to hide internal directories.