note

Documentation

Index

• Constants
• Variables
• type Book
  • func NewBook() *Book
  • func (b *Book) String() string
• type Books
  • func (b Books) Len() int
  • func (b Books) Less(i, j int) bool
  • func (b Books) Swap(i, j int)
• type Note
  • func NewNote() *Note
  • func (n *Note) GetTagIDsArray() []int64
  • func (n *Note) GetTagStringArray() []string
  • func (n *Note) MarshalJSON() ([]byte, error)
  • func (n *Note) String() string
• type Notes
  • func (n Notes) Len() int
  • func (n Notes) Less(i, j int) bool
  • func (n Notes) Swap(i, j int)
• type Tag
  • func NewTag() *Tag
  • func (t *Tag) String() string
• type Tags
  • func (t Tags) Len() int
  • func (t Tags) Less(i, j int) bool
  • func (t Tags) Swap(i, j int)

Constants

const MaxStringLen = 131070

Always a good idea to have a upper limit

Variables

var (
	Basic = "basic"
	URL   = "url"

	NoteTypes = []string{
		Basic,
		URL,
	}
)

Note types

Types

type Book

type Book struct {
	ID       int64
	Created  time.Time
	Modified time.Time

	Name string
}

Book is a collection of notes

func NewBook

func NewBook() *Book

NewBook returns a new Book

func (*Book) String

func (b *Book) String() string

type Books

type Books []*Book

func (Books) Len

func (b Books) Len() int

func (Books) Less

func (b Books) Less(i, j int) bool

func (Books) Swap

func (b Books) Swap(i, j int)

type Note

type Note struct {
	ID       int64
	Created  time.Time
	Modified time.Time

	Type  string
	Title string
	Body  string

	Book *Book
	Tags []*Tag
}

Note is our main struct for storing notes and their meta data.

func NewNote

func NewNote() *Note

NewNote returns a new Note

func (*Note) GetTagIDsArray

func (n *Note) GetTagIDsArray() []int64

func (*Note) GetTagStringArray

func (n *Note) GetTagStringArray() []string

GetTagStringArray returns a list of the note's tag names

func (*Note) MarshalJSON

func (n *Note) MarshalJSON() ([]byte, error)

MarshalJSON customer json Marshaler

func (*Note) String

func (n *Note) String() string

type Notes

type Notes []*Note

func (Notes) Len

func (n Notes) Len() int

func (Notes) Less

func (n Notes) Less(i, j int) bool

func (Notes) Swap

func (n Notes) Swap(i, j int)

type Tag

type Tag struct {
	ID       int64
	Created  time.Time
	Modified time.Time

	Name string
}

Tag is a term used as meta data for more accurate searching and labeling.

func NewTag

func NewTag() *Tag

NewTag returns a new Tag

func (*Tag) String

func (t *Tag) String() string

type Tags

type Tags []*Tag

func (Tags) Len

func (t Tags) Len() int

func (Tags) Less

func (t Tags) Less(i, j int) bool

func (Tags) Swap

func (t Tags) Swap(i, j int)