entry

Documentation

Index

• Constants
• func Append(file io.Writer, entry Entry) error
• func AppendFile(path string, entry Entry) error
• func Compare(a, b Entry) int
• func DurationMap(entries []Entry, cutoff time.Time) map[string]time.Duration
• func Total(totals map[string]time.Duration) time.Duration
• type Entry
  • func Filter(entries []Entry, start, end time.Time) []Entry
  • func ReadAll(file io.Reader) ([]Entry, error)
  • func ReadAllFromFile(path string) ([]Entry, error)
  • func (entry *Entry) UnmarshalJSON(b []byte) error
• type FileHandler
  • func NewFileHandler(filename string) (*FileHandler, error)
  • func (handler *FileHandler) CreateEntry(newEntry Entry) error
  • func (handler *FileHandler) GetAllEntries(options ...Option) ([]Entry, error)
• type Option
  • func Today() Option
• type ScheduleEntry
• type Summary
  • func Summarize(entries []Entry) Summary

Constants

const NUM_RECORDS = 3

Functions

func Append

func Append(file io.Writer, entry Entry) error

func AppendFile

func AppendFile(path string, entry Entry) error

func Compare

func Compare(a, b Entry) int

func DurationMap

func DurationMap(entries []Entry, cutoff time.Time) map[string]time.Duration

TODO: This function is never used...

func Total

func Total(totals map[string]time.Duration) time.Duration

TODO: This function is not used either...

Types

type Entry

type Entry struct {
	Time     time.Time `json:"time"`
	Category string    `json:"category"` // TODO: Make its own type with sub categories ex: "foo/bar"
	Note     string    `json:"note"`
}

func Filter

func Filter(entries []Entry, start, end time.Time) []Entry

func ReadAll

func ReadAll(file io.Reader) ([]Entry, error)

func ReadAllFromFile

func ReadAllFromFile(path string) ([]Entry, error)

func (*Entry) UnmarshalJSON

func (entry *Entry) UnmarshalJSON(b []byte) error

type FileHandler

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

func NewFileHandler

func NewFileHandler(filename string) (*FileHandler, error)

func (*FileHandler) CreateEntry

func (handler *FileHandler) CreateEntry(newEntry Entry) error

func (*FileHandler) GetAllEntries

func (handler *FileHandler) GetAllEntries(options ...Option) ([]Entry, error)

type Option

type Option func([]Entry) ([]Entry, error)

func Today

func Today() Option

type ScheduleEntry

type ScheduleEntry struct {
	Entry    Entry
	Duration time.Duration
}

type Summary

type Summary struct {
	Schedule   []ScheduleEntry
	Categories map[string]time.Duration
	Total      time.Duration
}

func Summarize

func Summarize(entries []Entry) Summary