configuration

Documentation

Index

• Constants
• type Catchall
  • func (instance *Catchall) Flags() []cli.Flag
  • func (instance Catchall) GetExcludes() []string
  • func (instance Catchall) GetIncludes() []string
  • func (instance Catchall) GetTarget() string
  • func (instance *Catchall) IsEligible(candidate string) (bool, error)
  • func (instance Catchall) Merge(with Catchall) Catchall
  • func (instance *Catchall) Validate(using goxr.Box) (errors []error)
• type Configuration
  • func OfBox(box goxr.Box) (c Configuration, rErr error)
  • func Read(reader io.Reader) (c Configuration, err error)
  • func (instance *Configuration) Flags() (result []cli.Flag)
  • func (instance Configuration) Merge(with Configuration) (result Configuration)
  • func (instance *Configuration) Validate(using goxr.Box) (errors []error)
  • func (instance *Configuration) ValidateAndSummarize(using goxr.Box) error
• type HttpAddress
  • func (instance *HttpAddress) Set(plain string) error
  • func (instance HttpAddress) String() string
• type Listen
  • func (instance *Listen) Flags() []cli.Flag
  • func (instance Listen) GetHttpAddress() string
  • func (instance Listen) Merge(with Listen) Listen
  • func (instance *Listen) Validate(using goxr.Box) (errors []error)
• type Logging
  • func (instance *Logging) Flags() []cli.Flag
  • func (instance Logging) GetAccessLog() bool
  • func (instance Logging) Merge(with Logging) Logging
  • func (instance *Logging) Validate(_ goxr.Box) (errors []error)
• type Paths
  • func (instance *Paths) FindStatusCode(code int) string
  • func (instance *Paths) Flags() []cli.Flag
  • func (instance Paths) GetExcludes() []string
  • func (instance Paths) GetIncludes() []string
  • func (instance Paths) GetIndex() string
  • func (instance Paths) GetStatusCodes() map[int]string
  • func (instance Paths) Merge(with Paths) Paths
  • func (instance *Paths) PathAllowed(candidate string) (bool, error)
  • func (instance *Paths) Validate(using goxr.Box) (errors []error)
• type Response
  • func (instance *Response) Flags() []cli.Flag
  • func (instance Response) GetGzip() bool
  • func (instance Response) GetHeaders() map[string][]string
  • func (instance Response) GetMimeTypes() map[string]string
  • func (instance Response) GetWithContentType() bool
  • func (instance Response) GetWithEtag() bool
  • func (instance Response) GetWithLastModified() bool
  • func (instance Response) Merge(with Response) Response
  • func (instance *Response) Validate(using goxr.Box) (errors []error)

Constants

const LocationInBox = `goxr-server.yaml`

Types

type Catchall

type Catchall struct {
	Target   *string   `yaml:"target,omitempty"`
	Includes *[]string `yaml:"includes,omitempty"`
	Excludes *[]string `yaml:"excludes,omitempty"`
	// contains filtered or unexported fields
}

func (*Catchall) Flags

func (instance *Catchall) Flags() []cli.Flag

func (Catchall) GetExcludes

func (instance Catchall) GetExcludes() []string

func (Catchall) GetIncludes

func (instance Catchall) GetIncludes() []string

func (Catchall) GetTarget

func (instance Catchall) GetTarget() string

func (*Catchall) IsEligible

func (instance *Catchall) IsEligible(candidate string) (bool, error)

func (Catchall) Merge

func (instance Catchall) Merge(with Catchall) Catchall

func (*Catchall) Validate

func (instance *Catchall) Validate(using goxr.Box) (errors []error)

type Configuration

type Configuration struct {
	Listen   Listen   `yaml:"listen,omitempty"`
	Paths    Paths    `yaml:"paths,omitempty"`
	Response Response `yaml:"response,omitempty"`
	Logging  Logging  `yaml:"logging,omitempty"`
}

func OfBox

func OfBox(box goxr.Box) (c Configuration, rErr error)

func Read

func Read(reader io.Reader) (c Configuration, err error)

func (*Configuration) Flags

func (instance *Configuration) Flags() (result []cli.Flag)

func (Configuration) Merge

func (instance Configuration) Merge(with Configuration) (result Configuration)

func (*Configuration) Validate

func (instance *Configuration) Validate(using goxr.Box) (errors []error)

func (*Configuration) ValidateAndSummarize

func (instance *Configuration) ValidateAndSummarize(using goxr.Box) error

type HttpAddress

type HttpAddress string

func (*HttpAddress) Set

func (instance *HttpAddress) Set(plain string) error

func (HttpAddress) String

func (instance HttpAddress) String() string

type Listen

type Listen struct {
	HttpAddress HttpAddress `yaml:"httpAddress,omitempty"`
}

func (*Listen) Flags

func (instance *Listen) Flags() []cli.Flag

func (Listen) GetHttpAddress

func (instance Listen) GetHttpAddress() string

func (Listen) Merge

func (instance Listen) Merge(with Listen) Listen

func (*Listen) Validate

func (instance *Listen) Validate(using goxr.Box) (errors []error)

type Logging

type Logging struct {
	log.Configuration `yaml:",inline"`
	AccessLog         *bool `yaml:"accessLog,omitempty"`
}

func (*Logging) Flags

func (instance *Logging) Flags() []cli.Flag

func (Logging) GetAccessLog

func (instance Logging) GetAccessLog() bool

func (Logging) Merge

func (instance Logging) Merge(with Logging) Logging

func (*Logging) Validate

func (instance *Logging) Validate(_ goxr.Box) (errors []error)

type Paths

type Paths struct {
	Catchall    Catchall       `yaml:"catchall,omitempty"`
	Index       *string        `yaml:"index,omitempty"`
	StatusCodes map[int]string `yaml:"statusCodes,omitempty"`
	Includes    *[]string      `yaml:"includes,omitempty"`
	Excludes    *[]string      `yaml:"excludes,omitempty"`
	// contains filtered or unexported fields
}

func (*Paths) FindStatusCode

func (instance *Paths) FindStatusCode(code int) string

func (*Paths) Flags

func (instance *Paths) Flags() []cli.Flag

func (Paths) GetExcludes

func (instance Paths) GetExcludes() []string

func (Paths) GetIncludes

func (instance Paths) GetIncludes() []string

func (Paths) GetIndex

func (instance Paths) GetIndex() string

func (Paths) GetStatusCodes

func (instance Paths) GetStatusCodes() map[int]string

func (Paths) Merge

func (instance Paths) Merge(with Paths) Paths

func (*Paths) PathAllowed

func (instance *Paths) PathAllowed(candidate string) (bool, error)

func (*Paths) Validate

func (instance *Paths) Validate(using goxr.Box) (errors []error)

type Response

type Response struct {
	MimeTypes        map[string]string   `yaml:"mimeTypes,omitempty"`
	Gzip             *bool               `yaml:"gzip,omitempty"`
	Headers          map[string][]string `yaml:"headers,omitempty"`
	WithEtag         *bool               `yaml:"withEtag,omitempty"`
	WithLastModified *bool               `yaml:"withLastModified,omitempty"`
	WithContentType  *bool               `yaml:"withContentType,omitempty"`
}

func (*Response) Flags

func (instance *Response) Flags() []cli.Flag

func (Response) GetGzip

func (instance Response) GetGzip() bool

func (Response) GetHeaders

func (instance Response) GetHeaders() map[string][]string

func (Response) GetMimeTypes

func (instance Response) GetMimeTypes() map[string]string

func (Response) GetWithContentType

func (instance Response) GetWithContentType() bool

func (Response) GetWithEtag

func (instance Response) GetWithEtag() bool

func (Response) GetWithLastModified

func (instance Response) GetWithLastModified() bool

func (Response) Merge

func (instance Response) Merge(with Response) Response

func (*Response) Validate

func (instance *Response) Validate(using goxr.Box) (errors []error)