predict

Documentation

Overview

Package predict provides helper functions for completion predictors.

Index

• Variables
• func Or(ps ...complete.Predictor) complete.Predictor
• type FilesPredictor
  • func Dirs(pattern string) FilesPredictor
  • func Files(pattern string) FilesPredictor
  • func (f FilesPredictor) Predict(prefix string) (options []string)
• type FilesSet
  • func (s FilesSet) Predict(prefix string) (prediction []string)
• type Set
  • func (p Set) Predict(_ string) (options []string)

Variables

var (
	// Something is used to indicate that does not completes somthing. Such that other prediction
	// wont be applied.
	Something = Set{""}

	// Nothing is used to indicate that does not completes anything.
	Nothing = Set{}
)

Functions

func Or

func Or(ps ...complete.Predictor) complete.Predictor

Or unions prediction functions, so that the result predication is the union of their predications.

Types

type FilesPredictor

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

func Dirs

func Dirs(pattern string) FilesPredictor

Dirs returns a predictor that predict directory paths. If a non-empty pattern is given, the predicted paths will match that pattern.

func Files

func Files(pattern string) FilesPredictor

Dirs returns a predictor that predict file or directory paths. If a non-empty pattern is given, the predicted paths will match that pattern.

func (FilesPredictor) Predict

func (f FilesPredictor) Predict(prefix string) (options []string)

Predict searches for files according to the given prefix. If the only predicted path is a single directory, the search will continue another recursive layer into that directory.

type FilesSet

type FilesSet []string

FilesSet predict according to file rules to a given fixed set of file names.

func (FilesSet) Predict

func (s FilesSet) Predict(prefix string) (prediction []string)

type Set

type Set []string

Set predicts a set of predefined values.

func (Set) Predict

func (p Set) Predict(_ string) (options []string)