interesting
/
complete
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
predict/options.go
View File

@ -41,11 +41,13 @@ func OptCheck() Option {
} }
} }
// Config stores prediction options.
type Config struct { type Config struct {
complete.Predictor complete.Predictor
check bool check bool
} }
// Options return a config from a list of options.
func Options(os ...Option) Config { func Options(os ...Option) Config {
var op Config var op Config
for _, f := range os { for _, f := range os {
@ -61,6 +63,8 @@ func (c Config) Predict(prefix string) []string {
return nil 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 { func (c Config) Check(value string) error {
if !c.check || c.Predictor == nil { if !c.check || c.Predictor == nil {
return nil return nil