adr

Documentation

Index

• Variables
• func ForEach(conf *config.Config, callback func(*Adr) error) error
• func Index(conf *config.Config) error
• func Update(conf *config.Config, adr *Adr) error
• type Adr
  • func ByID(conf *config.Config, number Number) (*Adr, error)
  • func Create(conf *config.Config, title string) (*Adr, error)
  • func Parse(path string) (*Adr, error)
• type Adrs
  • func List(conf *config.Config) (Adrs, error)
• type Number
• type Status

Variables

var ErrAdr = errors.New("adr")

var ErrForEachStop = errors.New("stop iterating")

Functions

func ForEach

func ForEach(conf *config.Config, callback func(*Adr) error) error

func Index

func Index(conf *config.Config) error

func Update

func Update(conf *config.Config, adr *Adr) error

Types

type Adr

type Adr struct {
	Filename string `yaml:"-"`
	Type     string `yaml:"type"`
	Number   Number `yaml:"number"`
	Title    string `yaml:"title"`
	Date     string `yaml:"date"`
	Status   Status `yaml:"status"`
	Link     Number `yaml:"link,omitempty"`
	Body     []byte `yaml:"-"`
}

func ByID

func ByID(conf *config.Config, number Number) (*Adr, error)

func Create

func Create(conf *config.Config, title string) (*Adr, error)

func Parse

func Parse(path string) (*Adr, error)

type Adrs

type Adrs map[Number]*Adr

func List

func List(conf *config.Config) (Adrs, error)

type Number

type Number int

type Status

type Status string

const (
	StatusProposed   Status = "proposed"
	StatusAccepted   Status = "accepted"
	StatusDeprecated Status = "deprecated"
	StatusSuperseded Status = "superseded"
)