journal

Documentation

Index

• Constants
• type Client
  • func New() *Client
  • func (c *Client) Add(entry Entry)
  • func (c *Client) IsEmpty() bool
• type Entry
• type EntryLevel
• type EntryStatus
  • func (es *EntryStatus) IsSkipped() bool
• type Journal
  • func (j Journal) IsEmpty() bool
  • func (j Journal) MarshalJSON() ([]byte, error)

Constants

const (
	EntryLevelError   = EntryLevel("error")
	EntryLevelWarning = EntryLevel("warning")
	EntryLevelSkip    = EntryLevel("skip")
	EntryLevelSuccess = EntryLevel("success")
)

const (
	EntryStatusOutdated    = EntryStatus("Outdated file")
	EntryStatusNotIncluded = EntryStatus("Not included")
	EntryStatusExcluded    = EntryStatus("Excluded")
	EntryStatusNeverDl     = EntryStatus("Never downloaded")
	EntryStatusAlreadyDl   = EntryStatus("Already downloaded")
	EntryStatusSizeDiff    = EntryStatus("Exists but size is different")
	EntryStatusHashExists  = EntryStatus("Hash sum exists")
)

Types

type Client

type Client struct {
	Journal
}

Client represents an active journal object

func New

func New() *Client

New creates new journal instance

func (*Client) Add

func (c *Client) Add(entry Entry)

Add adds an entry in the journal

func (*Client) IsEmpty

func (c *Client) IsEmpty() bool

IsEmpty checks if journal is empty

type Entry

type Entry struct {
	File   string      `json:"file,omitempty"`
	Status EntryStatus `json:"status,omitempty"`
	Level  EntryLevel  `json:"level,omitempty"`
	Text   string      `json:"text,omitempty"`
}

Entry represents a journal entry

type EntryLevel

type EntryLevel string

EntryLevel represents an entry kevek

type EntryStatus

type EntryStatus string

EntryStatus represents entry status

func (*EntryStatus) IsSkipped

func (es *EntryStatus) IsSkipped() bool

type Journal

type Journal struct {
	ServerHost string  `json:"-"`
	Entries    []Entry `json:"entries,omitempty"`
	Count      struct {
		Success int `json:"success,omitempty"`
		Error   int `json:"error,omitempty"`
		Skip    int `json:"skip,omitempty"`
	} `json:"count,omitempty"`
	Status   string        `json:"status,omitempty"`
	Duration time.Duration `json:"duration,omitempty"`
}

Journal holds journal entries

func (Journal) IsEmpty

func (j Journal) IsEmpty() bool

IsEmpty checks if journal is empty

func (Journal) MarshalJSON

func (j Journal) MarshalJSON() ([]byte, error)