config

Documentation

Index

• Variables
• type Config
  • func LoadFile(filename string) (*Config, error)
  • func (c *Config) GetDefaultMessage() TargetMessage
  • func (c *Config) String() string
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Coordinator
  • func NewCoordinator(configFilePath string, frozenConfig *Config, l log.Logger) *Coordinator
  • func (c *Coordinator) Reload() error
  • func (c *Coordinator) Subscribe(ss ...func(*Config) error)
• type Secret
  • func (s Secret) MarshalJSON() ([]byte, error)
  • func (s Secret) MarshalYAML() (interface{}, error)
  • func (s *Secret) UnmarshalYAML(unmarshal func(interface{}) error) error
• type SecretURL
  • func (s *SecretURL) Copy() SecretURL
  • func (s SecretURL) MarshalJSON() ([]byte, error)
  • func (s SecretURL) MarshalYAML() (interface{}, error)
  • func (s *SecretURL) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Target
  • func (c *Target) UnmarshalYAML(unmarshal func(interface{}) error) error
• type TargetMention
• type TargetMessage
  • func (c *TargetMessage) UnmarshalYAML(unmarshal func(interface{}) error) error
• type URL
  • func ParseURL(s string) (*URL, error)
  • func (u *URL) MarshalJSON() ([]byte, error)
  • func (u *URL) MarshalYAML() (interface{}, error)
  • func (u *URL) UnmarshalYAML(unmarshal func(interface{}) error) error

Variables

var (
	DefaultConfig = Config{
		Timeout: 5 * time.Second,
	}
	DefaultTarget        = Target{}
	DefaultTargetMessage = TargetMessage{
		Title: `{{ template "ding.link.title" . }}`,
		Text:  `{{ template "ding.link.content" . }}`,
	}
)

Types

type Config

type Config struct {
	Template       string            `yaml:"template,omitempty"`
	Templates      []string          `yaml:"templates,omitempty"`
	DefaultMessage *TargetMessage    `yaml:"default_message,omitempty"`
	Timeout        time.Duration     `yaml:"timeout"`
	Targets        map[string]Target `yaml:"targets"`
}

func LoadFile

func LoadFile(filename string) (*Config, error)

func (*Config) GetDefaultMessage

func (c *Config) GetDefaultMessage() TargetMessage

func (*Config) String

func (c *Config) String() string

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

type Coordinator

type Coordinator struct {
	// contains filtered or unexported fields
}

Coordinator coordinates configurations beyond the lifetime of a single configuration.

func NewCoordinator

func NewCoordinator(configFilePath string, frozenConfig *Config, l log.Logger) *Coordinator

NewCoordinator returns a new coordinator with the given configuration file path. It does not yet load the configuration from file. This is done in `Reload()`.

func (*Coordinator) Reload

func (c *Coordinator) Reload() error

Reload triggers a configuration reload from file and notifies all configuration change subscribers.

func (*Coordinator) Subscribe

func (c *Coordinator) Subscribe(ss ...func(*Config) error)

Subscribe subscribes the given Subscribers to configuration changes.

type Secret

type Secret string

Secret is a string that must not be revealed on marshaling.

func (Secret) MarshalJSON

func (s Secret) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for Secret.

func (Secret) MarshalYAML

func (s Secret) MarshalYAML() (interface{}, error)

MarshalYAML implements the yaml.Marshaler interface for Secret.

func (*Secret) UnmarshalYAML

func (s *Secret) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface for Secret.

type SecretURL

type SecretURL URL

SecretURL is a URL that must not be revealed on marshaling.

func (*SecretURL) Copy

func (s *SecretURL) Copy() SecretURL

Copy makes a deep-copy of the type

func (SecretURL) MarshalJSON

func (s SecretURL) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for SecretURL.

func (SecretURL) MarshalYAML

func (s SecretURL) MarshalYAML() (interface{}, error)

MarshalYAML implements the yaml.Marshaler interface for SecretURL.

func (*SecretURL) UnmarshalYAML

func (s *SecretURL) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface for SecretURL.

type Target

type Target struct {
	URL     *SecretURL     `yaml:"url,omitempty"`
	Secret  Secret         `yaml:"secret,omitempty"`
	Mention *TargetMention `yaml:"mention,omitempty"`
	Message *TargetMessage `yaml:"message,omitempty"`
}

func (*Target) UnmarshalYAML

func (c *Target) UnmarshalYAML(unmarshal func(interface{}) error) error

type TargetMention

type TargetMention struct {
	All     bool     `yaml:"all,omitempty"`
	Mobiles []string `yaml:"mobiles,omitempty"`
}

type TargetMessage

type TargetMessage struct {
	Title string `yaml:"title"`
	Text  string `yaml:"text"`
}

func (*TargetMessage) UnmarshalYAML

func (c *TargetMessage) UnmarshalYAML(unmarshal func(interface{}) error) error

type URL

type URL struct {
	url.URL
}

URL is a custom type that represents an HTTP or HTTPS URL and allows validation at configuration load time.

func ParseURL

func ParseURL(s string) (*URL, error)

ParseURL constructs a new URL from url string.

func (*URL) MarshalJSON

func (u *URL) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for URL.

func (*URL) MarshalYAML

func (u *URL) MarshalYAML() (interface{}, error)

MarshalYAML implements the yaml.Marshaler interface for URL.

func (*URL) UnmarshalYAML

func (u *URL) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface for URL.