Documentation ¶
Overview ¶
package idxconfig implements the dms3fs idxconfig file datastructures and utilities.
Index ¶
- Constants
- func Filename(configroot string) (string, error)
- func HumanOutput(value interface{}) ([]byte, error)
- func Marshal(value interface{}) ([]byte, error)
- func Path(configroot, extension string) (string, error)
- func PathRoot() (string, error)
- func ToMap(conf *IdxConfig) (map[string]interface{}, error)
- type Corpus
- type IdxConfig
- type Indexer
- type Kind
- type Metadata
- type RepoSet
- type Retriever
Constants ¶
View Source
const ( // DefaultPathName is the default idxconfig dir name DefaultPathName = ".dms3-fs/index" // DefaultPathRoot is the path to the default idxconfig dir location. DefaultPathRoot = "~/" + DefaultPathName // DefaultIdxConfigFile is the filename of the configuration file DefaultIdxConfigFile = "idxconfig" // EnvDir is the environment variable used to change the path root. EnvDir = "DMS3_PATH" // must be relative )
Variables ¶
This section is empty.
Functions ¶
func Filename ¶
Filename returns the configuration file path given a configuration root directory. If the configuration root directory is empty, use the default one
func HumanOutput ¶
HumanOutput gets a idxconfig value ready for printing
func Path ¶
Path returns the path `extension` relative to the configuration root. If an empty string is provided for `configroot`, the default root is used.
Types ¶
type Indexer ¶
type Indexer struct { Path string // path to index, ex: repo/base Memory string Stemmer string Normalize bool Stopper []string Corpus Corpus }
Indexer stores index repository server configuration.
Source Files ¶
Click to show internal directories.
Click to hide internal directories.