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
- API
  
  Reference documentation for the pkg.go.dev API
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

codecs

package

v0.3.0 Latest Latest Go to latest Published: Oct 4, 2026 License: MIT Imports: 19 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/vekio/overmind

Links

Open Source Insights

Documentation ¶

Overview ¶

Package codecs maps domain entities to AsciiDoc documents.

Index ¶

func Identify(source []byte) (uuid.UUID, ports.NoteKind, error)
type BookmarkCodec
- func (BookmarkCodec) Decode(source []byte) (*bookmarks.Bookmark, error)
- func (BookmarkCodec) Encode(entity *bookmarks.Bookmark) ([]byte, error)
type HabitCodec
- func (HabitCodec) Decode(source []byte) (*habits.Habit, error)
- func (HabitCodec) Encode(habit *habits.Habit) ([]byte, error)
type InboxCodec
- func (InboxCodec) Decode(source []byte) (*inbox.Inbox, error)
- func (InboxCodec) Encode(entity *inbox.Inbox) ([]byte, error)
type JournalCodec
- func (JournalCodec) Decode(source []byte) (*journals.Journal, error)
- func (JournalCodec) Encode(entity *journals.Journal) ([]byte, error)
type PageCodec
- func (PageCodec) Decode(source []byte) (*pages.Page, error)
- func (PageCodec) Encode(entity *pages.Page) ([]byte, error)
type PersonCodec
- func (PersonCodec) Decode(source []byte) (*persons.Person, error)
- func (PersonCodec) Encode(person *persons.Person) ([]byte, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Identify ¶

func Identify(source []byte) (uuid.UUID, ports.NoteKind, error)

Identify reads the identity and kind used to select a document's codec. Specific domain properties are validated by that codec's Decode method.

Types ¶

type BookmarkCodec ¶

type BookmarkCodec struct{}

func (BookmarkCodec) Decode ¶

func (BookmarkCodec) Decode(source []byte) (*bookmarks.Bookmark, error)

func (BookmarkCodec) Encode ¶

func (BookmarkCodec) Encode(entity *bookmarks.Bookmark) ([]byte, error)

type HabitCodec ¶

type HabitCodec struct{}

func (HabitCodec) Decode ¶

func (HabitCodec) Decode(source []byte) (*habits.Habit, error)

func (HabitCodec) Encode ¶

func (HabitCodec) Encode(habit *habits.Habit) ([]byte, error)

type InboxCodec ¶

type InboxCodec struct{}

func (InboxCodec) Decode ¶

func (InboxCodec) Decode(source []byte) (*inbox.Inbox, error)

func (InboxCodec) Encode ¶

func (InboxCodec) Encode(entity *inbox.Inbox) ([]byte, error)

type JournalCodec ¶

type JournalCodec struct{}

func (JournalCodec) Decode ¶

func (JournalCodec) Decode(source []byte) (*journals.Journal, error)

func (JournalCodec) Encode ¶

func (JournalCodec) Encode(entity *journals.Journal) ([]byte, error)

type PageCodec ¶

type PageCodec struct{}

func (PageCodec) Decode ¶

func (PageCodec) Decode(source []byte) (*pages.Page, error)

func (PageCodec) Encode ¶

func (PageCodec) Encode(entity *pages.Page) ([]byte, error)

type PersonCodec ¶

type PersonCodec struct{}

func (PersonCodec) Decode ¶

func (PersonCodec) Decode(source []byte) (*persons.Person, error)

func (PersonCodec) Encode ¶

func (PersonCodec) Encode(person *persons.Person) ([]byte, error)

Source Files ¶

View all Source files