papernet

Documentation

Index

• type Facets
• type Pagination
• type Paper
• type PaperIndex
• type PaperRepository
• type SearchParams
• type SearchResults
• type TagIndex
• type TagsFacet

Types

type Facets

type Facets struct {
	Tags TagsFacet `json:"tags,omitempty"`
}

type Pagination

type Pagination struct {
	Total  uint64 `json:"total"`
	Limit  uint64 `json:"limit"`
	Offset uint64 `json:"offset"`
}

type Paper

type Paper struct {
	ID      int      `json:"id"`
	Title   string   `json:"title"`
	Summary string   `json:"summary"`
	Authors []string `json:"authors"`

	Tags       []string `json:"tags"`
	References []string `json:"references"`

	CreatedAt time.Time `json:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt"`
}

type PaperIndex

type PaperIndex interface {
	Index(*Paper) error
	Search(SearchParams) (SearchResults, error)
	Delete(int) error
}

type PaperRepository

type PaperRepository interface {
	Get(...int) ([]Paper, error)
	List() ([]Paper, error)
	Upsert(*Paper) error
	Delete(int) error
}

type SearchParams

type SearchParams struct {
	IDs  []int    `json:"ids"`
	Q    string   `json:"q"`
	Tags []string `json:"tags"`

	Limit  uint64 `json:"limit"`
	Offset uint64 `json:"offset"`
}

type SearchResults

type SearchResults struct {
	IDs        []int
	Facets     Facets
	Pagination Pagination
}

type TagIndex

type TagIndex interface {
	Index(string) error
	Search(string) ([]string, error)
}

type TagsFacet

type TagsFacet []struct {
	Tag   string `json:"tag"`
	Count int    `json:"count"`
}