entry

Documentation

Index

• Variables
• type Entry
  • func New(filePath string) (Entry, error)
  • func (en Entry) After(other Entry) (bool, error)
  • func (en *Entry) Content() (string, []string, error)
  • func (en Entry) ContentWithLimit(sizeLimit int) (string, []string, error)
  • func (en Entry) Edit() error
  • func (en Entry) FileAction(question string) error
  • func (en Entry) HasHashtags() (bool, error)
  • func (en Entry) HasTag(tag string) bool
  • func (en *Entry) MarkPosted() error
  • func (en *Entry) Name() string
  • func (en Entry) Remove() error
  • func (en Entry) String() string
  • func (en Entry) Timestamp() (time.Time, error)
• type State
  • func (s State) String() string

Variables

var (
	ErrSizeLimitExceeded = errors.New("message size limit exceeded")
)

var Zero = Entry{}

var Zeroes = []Entry{}

Types

type Entry

type Entry struct {
	Path  string
	Time  time.Time
	State State
	Tags  map[string]struct{}
}

func New

func New(filePath string) (Entry, error)

filePath format: /foo/foobarbaz.something.here.txt.STAMP.{posted,queued} or for inboxed: /foo.txt or inboxed with tags: /foo.prio.ask.txt

func (Entry) After

func (en Entry) After(other Entry) (bool, error)

func (*Entry) Content

func (en *Entry) Content() (string, []string, error)

func (Entry) ContentWithLimit

func (en Entry) ContentWithLimit(sizeLimit int) (string, []string, error)

Returns the content and also checks for the size limit

func (Entry) Edit

func (en Entry) Edit() error

func (Entry) FileAction

func (en Entry) FileAction(question string) error

func (Entry) HasHashtags

func (en Entry) HasHashtags() (bool, error)

func (Entry) HasTag

func (en Entry) HasTag(tag string) bool

func (*Entry) MarkPosted

func (en *Entry) MarkPosted() error

func (*Entry) Name

func (en *Entry) Name() string

Returns the Name, e.g. foo.bar.baz from /path/foo.bar.baz.TIMESTAMP.posted

func (Entry) Remove

func (en Entry) Remove() error

func (Entry) String

func (en Entry) String() string

func (Entry) Timestamp

func (en Entry) Timestamp() (time.Time, error)

type State

type State int

const (
	Unknown State = iota
	Inboxed
	Queued
	Posted
)

func (State) String

func (s State) String() string