b12449f9e3
One small breaking change: a provider set can no longer include an interface binding to a concrete type that is not being provided (directly or indirectly) by the provider set. I can't imagine a reasonable use case for the previous behavior, so this likely will catch more errors In terms of operation, binding conflict error messages will now give much more specific line numbers, since they will be reported closer to where the problem occurred. Now that provider sets gather this information, it can be exposed in the package API. gowire now uses this information instead of trying to build it itself. Fixes google/go-cloud#29
77 lines
2.2 KiB
Go
77 lines
2.2 KiB
Go
// Copyright 2018 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// Package wire contains directives for Wire code generation.
|
|
package wire
|
|
|
|
// ProviderSet is a marker type that collects a group of providers.
|
|
type ProviderSet struct{}
|
|
|
|
// NewSet creates a new provider set that includes the providers in
|
|
// its arguments. Each argument is either an exported function value,
|
|
// an exported struct (zero) value, a provider set, a call to Bind, or
|
|
// a call to Value.
|
|
func NewSet(...interface{}) ProviderSet {
|
|
return ProviderSet{}
|
|
}
|
|
|
|
// Build is placed in the body of an injector function to declare the
|
|
// providers to use. Its arguments are the same as NewSet. Its return
|
|
// value is an error message that can be sent to panic.
|
|
//
|
|
// Example:
|
|
//
|
|
// func injector(ctx context.Context) (*sql.DB, error) {
|
|
// panic(wire.Build(otherpkg.FooSet, myProviderFunc))
|
|
// }
|
|
func Build(...interface{}) string {
|
|
return "implementation not generated, run gowire"
|
|
}
|
|
|
|
// A Binding maps an interface to a concrete type.
|
|
type Binding struct{}
|
|
|
|
// Bind declares that a concrete type should be used to satisfy a
|
|
// dependency on the type of iface, which must be a pointer to an
|
|
// interface type.
|
|
//
|
|
// Example:
|
|
//
|
|
// type Fooer interface {
|
|
// Foo()
|
|
// }
|
|
//
|
|
// type MyFoo struct{}
|
|
//
|
|
// func (MyFoo) Foo() {}
|
|
//
|
|
// var MySet = wire.NewSet(
|
|
// MyFoo{},
|
|
// wire.Bind(new(Fooer), new(MyFoo)))
|
|
func Bind(iface, to interface{}) Binding {
|
|
return Binding{}
|
|
}
|
|
|
|
// A ProvidedValue is an expression that is copied to the generated injector.
|
|
type ProvidedValue struct{}
|
|
|
|
// Value binds an expression to provide the type of the expression.
|
|
//
|
|
// Example:
|
|
//
|
|
// var MySet = wire.NewSet(wire.Value([]string(nil)))
|
|
func Value(interface{}) ProvidedValue {
|
|
return ProvidedValue{}
|
|
}
|