Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

downcache

package module

Go to main page

Versions in this module

v0

v0.0.2

Sep 3, 2024

Changes in this version

+ func PostPathID(postType, slug string) string

+ type CacheStore interface

+ Clear func(ctx context.Context) error

+ Close func() error

+ Create func(ctx context.Context, post *Post) (*Post, error)

+ Delete func(ctx context.Context, postType, slug string) error

+ Get func(ctx context.Context, postType, slug string) (*Post, error)

+ GetTaxonomies func(ctx context.Context) ([]string, error)

+ GetTaxonomyTerms func(ctx context.Context, taxonomy string) ([]string, error)

+ Init func() error

+ Search func(ctx context.Context, opts FilterOptions) ([]*Post, int, error)

+ Update func(ctx context.Context, oldType, oldSlug string, post *Post) error

+ type DefaultMarkdownProcessor struct

+ func (d DefaultMarkdownProcessor) GenerateFrontmatter(meta *PostMeta, format FrontmatterFormat) (string, error)

+ func (d DefaultMarkdownProcessor) Process(input []byte) (*Post, error)

type DownCache

+ func (cm *DownCache) Create(ctx context.Context, post *Post) (*Post, error)

+ func (cm *DownCache) Delete(ctx context.Context, postType, slug string) error

+ func (cm *DownCache) Get(ctx context.Context, postType, slug string) (*Post, error)

+ func (cm *DownCache) Search(ctx context.Context, filter FilterOptions) ([]*Post, int, error)

+ func (cm *DownCache) SyncAll(ctx context.Context) error

+ func (cm *DownCache) Update(ctx context.Context, oldType, oldSlug string, post *Post) error

type FilterOptions

+ FilterAuthor string

+ FilterProperties []KeyValueFilter

+ FilterTaxonomies []KeyValueFilter

+ SplitPinned bool

+ type KeyValueFilter struct

+ Key string

+ Value string

+ type LocalMarkdownFS struct

+ func NewLocalMarkdownFS(rootDir string, proc MarkdownProcessor, format FrontmatterFormat) *LocalMarkdownFS

+ func (fs *LocalMarkdownFS) Delete(_ context.Context, postType, slug string) error

+ func (fs *LocalMarkdownFS) Move(_ context.Context, oldType, oldSlug, newType, newSlug string) error

+ func (fs *LocalMarkdownFS) Read(_ context.Context, postType, slug string) (*Post, error)

+ func (fs *LocalMarkdownFS) Walk(ctx context.Context) (<-chan *Post, <-chan error)

+ func (fs *LocalMarkdownFS) Write(_ context.Context, post *Post) error

+ type MarkdownFS interface

+ Delete func(ctx context.Context, postType, slug string) error

+ Move func(ctx context.Context, oldType, oldSlug, newType, newSlug string) error

+ Read func(ctx context.Context, postType, slug string) (*Post, error)

+ Walk func(ctx context.Context) (<-chan *Post, <-chan error)

+ Write func(ctx context.Context, post *Post) error

+ type MarkdownProcessor interface

+ GenerateFrontmatter func(meta *PostMeta, format FrontmatterFormat) (string, error)

+ Process func(input []byte) (*Post, error)

+ type MemoryCacheStore struct

+ func NewMemoryCacheStore() *MemoryCacheStore

+ func (m *MemoryCacheStore) Clear(ctx context.Context) error

+ func (m *MemoryCacheStore) Close() error

+ func (m *MemoryCacheStore) Create(ctx context.Context, post *Post) (*Post, error)

+ func (m *MemoryCacheStore) Delete(ctx context.Context, postType, slug string) error

+ func (m *MemoryCacheStore) Get(ctx context.Context, postType, slug string) (*Post, error)

+ func (m *MemoryCacheStore) GetTaxonomies(ctx context.Context) ([]string, error)

+ func (m *MemoryCacheStore) GetTaxonomyTerms(ctx context.Context, taxonomy string) ([]string, error)

+ func (m *MemoryCacheStore) Init() error

+ func (m *MemoryCacheStore) Search(ctx context.Context, options FilterOptions) ([]*Post, int, error)

+ func (m *MemoryCacheStore) Update(ctx context.Context, oldType, oldSlug string, post *Post) error

type Paginator

+ func NewPaginator(docs []*Post, total, currentPage, pageSize int, includeFeatured bool) Paginator

type Post

+ Created string

+ HTML string

+ PostID string

+ func (p *Post) Meta() *PostMeta

+ func (p *Post) PublishedTime() time.Time

type PostMeta

+ Author string

type PostType

+ func (pt PostType) IsAny() bool

+ func (pt PostType) String() string

+ type PostTypes []PostType

+ func (pts PostTypes) HasPostType(key string) bool

v0.0.1

Aug 27, 2024

Changes in this version

+ var ErrInvalidPostMeta = errors.New("invalid post metadata")

+ var ErrInvalidPostSlug = errors.New("invalid post slug")

+ var ErrInvalidPostType = errors.New("invalid post type")

+ var ErrMissingPostContent = errors.New("missing post content")

+ var ErrPostExists = errors.New("post already exists")

+ var ErrPostNotFound = errors.New("post not found")

+ func EstimateReadingTime(content string) string

+ func GenerateETag(content string) string

+ func IsValidPostPath(path string) bool

+ func PostID(postType, slug string) string

+ type Author struct

+ Active bool

+ AvatarURL string

+ Bio string

+ Country string

+ Links []AuthorLink

+ Name string

+ Username string

+ type AuthorLink struct

+ Icon string

+ Name string

+ URL string

+ type Database struct

+ func NewDatabase(dbPath string) (*Database, error)

+ func (d *Database) Close() error

+ type DownCache struct

+ func NewDownCache(opts Options) (*DownCache, error)

+ func (dg *DownCache) Close() error

+ func (dg *DownCache) CreatePost(postType, path, content string, meta *PostMeta) (string, error)

+ func (dg *DownCache) DeIndexPost(pathID string) error

+ func (dg *DownCache) DeletePost(postType, path string) error

+ func (dg *DownCache) GetPost(pathID string) (*Post, error)

+ func (dg *DownCache) GetPosts(filter FilterOptions) (Paginator, error)

+ func (dg *DownCache) GetTaxonomyTerms(taxonomy string) ([]string, error)

+ func (dg *DownCache) IndexPost(doc *Post) error

+ func (dg *DownCache) IndexPostType(postType PostType) (int, error)

+ func (dg *DownCache) Paginator(docs []*Post, total, currentPage, pageSize int, includeFeatured bool) Paginator

+ func (dg *DownCache) Reindex() (map[string]int, error)

+ func (dg *DownCache) SetFrontmatterFormat(format FrontmatterFormat)

+ func (dg *DownCache) SetPostType(typeKey PostTypeKey, postType PostType) error

+ func (dg *DownCache) UpdatePost(postType, path, content string, meta *PostMeta) (string, error)

+ type FilterOptions struct

+ FilterKey string

+ FilterPostType PostTypeKey

+ FilterSearch string

+ FilterStatus string

+ FilterTerm string

+ FilterType FilterType

+ FilterVisibility string

+ IncludeUnpublished bool

+ PageNum int

+ PageSize int

+ SortBy []string

+ SplitFeatured bool

+ type FilterType string

+ const FilterTypeAny

+ const FilterTypeAuthor

+ const FilterTypeTaxonomy

+ func (ft FilterType) String() string

+ type FrontmatterFormat string

+ const FrontmatterTOML

+ const FrontmatterYAML

+ type MarkdownParserFunc func(input []byte) (*Post, error)

+ func DefaultMarkdownParser() MarkdownParserFunc

+ type Options struct

+ Authors map[string]Author

+ ClearIndexes bool

+ DataDir string

+ FrontMatterFormat FrontmatterFormat

+ Logger *slog.Logger

+ MarkdownDir string

+ MarkdownParser MarkdownParserFunc

+ Reindex bool

+ Taxonomies map[string]string

+ type Paginator struct

+ AllPosts []*Post

+ CurrentPage int

+ FeaturedPosts []*Post

+ HasNext bool

+ HasPosts bool

+ HasPrev bool

+ NextPage int

+ NonFeaturedPosts []*Post

+ PageSize int

+ PrevPage int

+ TotalPages int

+ TotalPosts int

+ Visible bool

+ type Post struct

+ Author string

+ Content string

+ ETag string

+ EstimatedReadTime string

+ FileTimePath string

+ ID string

+ Name string

+ Photo string

+ Pinned bool

+ PostType string

+ Properties map[string]any

+ Published time.Time

+ Slug string

+ Status string

+ Subtitle string

+ Summary string

+ Taxonomies map[string][]string

+ Updated time.Time

+ Visibility string

+ func Deserialize(data []byte) (*Post, error)

+ func MarkdownToPost(md goldmark.Markdown, content []byte) (*Post, error)

+ func ReadFile(markdownParser MarkdownParserFunc, rootPath, path string, postType PostType) (*Post, error)

+ func (d *Post) FileTimeInSlug() string

+ func (d *Post) HasAuthor() bool

+ func (d *Post) HasFileTimeInSlug() bool

+ func (d *Post) HasName() bool

+ func (d *Post) HasPhoto() bool

+ func (d *Post) HasProperties() bool

+ func (d *Post) HasPublished() bool

+ func (d *Post) HasSubtitle() bool

+ func (d *Post) HasSummary() bool

+ func (d *Post) HasTaxonomies() bool

+ func (d *Post) HasTaxonomy(taxonomy string) bool

+ func (d *Post) HasUpdated() bool

+ func (d *Post) PublishedDate() string

+ func (d *Post) PublishedYear() int

+ func (d *Post) Serialize() ([]byte, error)

+ func (d *Post) SlugWithYear() string

+ func (d *Post) SlugWithYearMonth() string

+ func (d *Post) SlugWithYearMonthDay() string

+ func (d *Post) SlugWithoutDate() string

+ func (d *Post) Taxonomy(taxonomy string) []string

+ type PostMeta struct

+ Authors string

+ Name string

+ Photo string

+ Pinned bool

+ Properties map[string]any

+ Published time.Time

+ Status string

+ Subtitle string

+ Summary string

+ Taxonomies map[string][]string

+ Updated time.Time

+ Visibility string

+ func (dm *PostMeta) Validate() error

+ type PostStore interface

+ Close func() error

+ Create func(post *Post) (*Post, error)

+ Delete func(post *Post) error

+ GetBySlug func(slug string) (*Post, error)

+ Init func() error

+ Search func(opts FilterOptions) ([]*Post, error)

+ Update func(post *Post) error

+ type PostType struct

+ DirPattern string

+ FrontmatterCheck func(map[string]any) bool

+ TypeKey PostTypeKey

+ type PostTypeKey string

+ const PostTypeKeyAny

+ const PostTypeKeyArticle

+ const PostTypeKeyBookmark

+ const PostTypeKeyLink

+ const PostTypeKeyNote

+ const PostTypeKeyPage

+ func (ptk PostTypeKey) String() string

+ type PostTypesMap map[PostTypeKey]PostType

+ func DefaultPostTypes() PostTypesMap

+ func (ptm PostTypesMap) IsValidTypeKey(key string) bool

+ func (ptm PostTypesMap) PostTypeFromPath(filePath string) PostType

+ type SlugPath struct

+ FileTime *time.Time

+ FileTimePath string

+ PostType PostType

+ Slug string

+ func SlugifyPath(rootPath, fullPath string, postType PostType) SlugPath