config

Documentation

Index

• Variables
• type Config
  • func ParseConfig(configPath string) (Config, error)
  • func (c Config) Validate() error

Variables

var ErrEmptyConfigPath = errors.New("empty configuration file path")

ErrEmptyConfigPath defines a sentinel error for an empty config path.

Types

type Config

type Config struct {
	DataDir    string   `toml:"data_dir"`
	ListenAddr string   `toml:"listen_addr"`
	Seeds      []string `toml:"seeds" validate:"required,min=1"`
	ReseedSize uint     `toml:"reseed_size"`
	IPStackKey string   `toml:"ipstack_key" validate:"required,min=1"`

	CrawlInterval   uint `toml:"crawl_interval"`
	RecheckInterval uint `toml:"recheck_interval"`
}

Config defines all necessary tmcrawl configuration parameters.

func ParseConfig

func ParseConfig(configPath string) (Config, error)

ParseConfig attempts to read and parse a tmcrawl config from the given file path. An error is returned if reading or parsing the config fails.

func (Config) Validate

func (c Config) Validate() error

Validate returns an error if the Config object is invalid.