Options: added docs

This commit is contained in:
Eyal Posener 2019-11-22 15:03:53 +02:00
parent a48bf3f856
commit a138e3dfcf
1 changed files with 4 additions and 0 deletions

View File

@ -41,11 +41,13 @@ func OptCheck() Option {
}
}
// Config stores prediction options.
type Config struct {
complete.Predictor
check bool
}
// Options return a config from a list of options.
func Options(os ...Option) Config {
var op Config
for _, f := range os {
@ -61,6 +63,8 @@ func (c Config) Predict(prefix string) []string {
return nil
}
// Check checks that value is one of the predicted values, in case
// that the check field was set.
func (c Config) Check(value string) error {
if !c.check || c.Predictor == nil {
return nil