pipetdata

Documentation

Overview

Package pipetdata impliments meat of pipet, data access functions - which are being called out from CLI

Index

• Variables
• type DataStore
  • func NewDataStore(documentDir string) (*DataStore, error)
  • func (d *DataStore) Delete(id string) error
  • func (d *DataStore) Exist(filename string) bool
  • func (d *DataStore) Fullpath(id string) string
  • func (d *DataStore) List() (sns []*Snippet, err error)
  • func (d *DataStore) New(title string, tags ...string) (fn string, err error)
  • func (d *DataStore) Read(id string) (sn *Snippet, err error)
• type Snippet
  • func (s *Snippet) Marshal() ([]byte, error)
  • func (s *Snippet) Unmarshal(buf []byte) error

Variables

var (
	// EBadData error bad data on disk
	EBadData = fmt.Errorf("bad data")
)

Types

type DataStore

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

DataStore is the main structure for snippet access

func NewDataStore

func NewDataStore(documentDir string) (*DataStore, error)

NewDataStore creates a new datastore abastraction for storing notes. disk path is passed as documentDir

func (*DataStore) Delete

func (d *DataStore) Delete(id string) error

func (*DataStore) Exist

func (d *DataStore) Exist(filename string) bool

Exist checks with a snippet with the name exists.

func (*DataStore) Fullpath

func (d *DataStore) Fullpath(id string) string

func (*DataStore) List

func (d *DataStore) List() (sns []*Snippet, err error)

func (*DataStore) New

func (d *DataStore) New(title string, tags ...string) (fn string, err error)

New creates a new entry in snippets

func (*DataStore) Read

func (d *DataStore) Read(id string) (sn *Snippet, err error)

Read reads and parses a snippet document

type Snippet

type Snippet struct {
	Meta metadata
	Data string
}

Snippet is the data type holding the actual snippet

func (*Snippet) Marshal

func (s *Snippet) Marshal() ([]byte, error)

Marshal serializes snippet data into bytes. Format is --- yaml metadata front --- <text follows> This is very similiar to pandoc markdown except its just arbitary text for now.

func (*Snippet) Unmarshal

func (s *Snippet) Unmarshal(buf []byte) error

Unmarshal takes in note data with metadata blocks in yaml and populates Snippet structure. https://jekyllrb.com/docs/frontmatter/