Documentation
¶
Overview ¶
Package dict maintains stuff relevant to wordlists of different languages.
Code generated by sammyne. DO NOT EDIT.
Code generated by sammyne. DO NOT EDIT.
Index ¶
- Constants
- Variables
- func Disable(lang Language)
- func Enable(lang Language) error
- func LookUp(trie *trie.Trie, word string) (int, bool)
- func Register(lang Language, generator WordlistGenerator, description string) error
- func UseLanguage(lang Language) error
- func Whitespace(lang Language) string
- type Language
- type WordlistGenerator
Constants ¶
const ( Reserved = Language(iota) ChineseSimpilified ChineseTraditional English French Italian Japanese Korean Spanish )
enumerations of different languages as named
const ( // IdeographicSpaces is the whitespace used specifically for Japanese IdeographicSpaces = "\u3000" // ASCIISpace is the default whitespace employed for languages except above ASCIISpace = " " )
spaces enumerations
Variables ¶
var ( // ErrDisabledTrie signals trie for a given language has been disabled ErrDisabledTrie = errors.New("trie is disabled") // ErrOccupiedLanguage has been registered somewhere else ErrOccupiedLanguage = errors.New("language already occupied") // ErrUnknownLanguage signals a language as a parameter isn't registered ErrUnknownLanguage = errors.New("the provided language isn't registered") )
errors enumerations
Functions ¶
func LookUp ¶
LookUp searchs a given word against the given trie, and return the index (stored in its meta) of the word.
func Register ¶
func Register(lang Language, generator WordlistGenerator, description string) error
Register takes into record a given language, its wordlist generator and a brief description
func UseLanguage ¶
UseLanguage overrides the global default language to use.
func Whitespace ¶
Whitespace finds the whitespace for the given language
Types ¶
type Language ¶
type Language int
Language denotes the type of languages
func TrieToUse ¶
TrieToUse gets the trie bound to the given language if any. If no language provided, the global default will be employed. Both the trie and language bound to it (is the global default language if no language is provided) will be returned
func WordlistToUse ¶
WordlistToUse returns the wordlist bound to a language, which is the provided one if any, otherwise the global default language. The 2nd output is the language bound to the wordlist (the 1st output) in case of no error.
type WordlistGenerator ¶
type WordlistGenerator func() []string
WordlistGenerator is the signature of function generating a wordlist
Source Files