config

Documentation

Index

• type DBConfig
• type EnvType
  • func NewEnvType(raw string) (EnvType, error)
• type GAPIConfig
• type GeoConfig
  • func (c GeoConfig) MakeMapsBounds() *maps.LatLngBounds
• type HTTPConfig

Types

type DBConfig

type DBConfig struct {
	// ConnString holds the connection string used to connect to the
	// database
	ConnString string
}

DBConfig holds database configuration values

type EnvType

type EnvType string

EnvType is a string type alias used for application environment names. The application environment indicates the level of application stability and the target audience for clients.

const EnvDevelop EnvType = "develop"

EnvDev indicates that the application code is unstable. And should only be accessed by the developers

const EnvErr EnvType = "err"

EnvErr indicates that an error occurred while parsing a raw value into a EnvType

const EnvProd EnvType = "production"

EnvProd indicates that the application code is stable. And should be viewed by actual clients.

const EnvTest EnvType = "test"

EnvTest indicates that the application code is ustable. And that tests are being run on it. Only the test cases should access the application.

func NewEnvType

func NewEnvType(raw string) (EnvType, error)

NewEnvType creates a EnvType with the provided raw value. An error is returned if one occurs parsing this raw value into an EnvType. Nil on success.

type GAPIConfig

type GAPIConfig struct {
	// APIKey holds the GAPI authorization key
	APIKey string
}

GAPIConfig holds Google API related configuration

type GeoConfig

type GeoConfig struct {
	// BoundsNeLat holds the northeast bounds latitude of the area to look
	// for crime locations in
	BoundsNeLat float64

	// BoundsNeLong holds the northeast bounds longitude of the area to
	// look for crime locations in
	BoundsNeLong float64

	// BoundsSwLat holds the southwest bounds latitude of the area to look
	// for crime locations in
	BoundsSwLat float64

	// BoundsSwLong holds the southwest bounds longitude of the area to
	// look for crime locations in
	BoundsSwLong float64

	// AddrPostfix is the string appended to the end of crime address
	// before attempting to locate it on a map
	AddrPostfix string
}

GeoConfig holds configuration related to locating crimes from reports

func (GeoConfig) MakeMapsBounds

func (c GeoConfig) MakeMapsBounds() *maps.LatLngBounds

MakeMapsBounds constructs a Google Maps map.LatLngBounds struct from the GeoConfig.Bounds* fields. This can be used to indicate the bounds to the Google Maps SDK.

type HTTPConfig

type HTTPConfig struct {
	// Port is the system network port to serve HTTP content on
	Port uint
}

HTTPConfig holds web server related configuration