Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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

folio

package module

Go to main page

Versions in this module

v0

v0.0.4

Nov 8, 2024

v0.0.3

Oct 31, 2024

v0.0.2

Oct 29, 2024

Changes in this version

+ func Create[T Object](db Storage, constructor func(obj T) error, namespace, createdBy string) (T, error)

v0.0.1

Oct 18, 2024

Changes in this version

+ var ErrConflict = errors.New("storage: update of an outdated document")

+ var ErrKindNotFound = errors.New("resource: kind not found")

+ var ErrNotFound = errors.New("storage: document was not found")

+ func Count[T Object](db Storage, q Query) (int, error)

+ func Delete[T Object](db Storage, urn URN, deletedBy string) (T, error)

+ func Fetch[T Object](db Storage, urn URN) (T, error)

+ func Insert[T Object](db Storage, v T, createdBy string) (T, error)

+ func IsConflict(err error) bool

+ func IsNotFound(err error) bool

+ func New[T Object](namespace string, funcs ...func(obj T) error) (T, error)

+ func Search[T Object](db Storage, q Query) (iter.Seq[T], error)

+ func ToJSON(v Object) ([]byte, error)

+ func Update[T Object](db Storage, v T, updatedBy string) (T, error)

+ func Upsert[T Object](db Storage, v T, updatedBy string) (T, error)

+ type Embed struct

+ Registry Registry

+ Value Object

+ func (r *Embed) UnmarshalJSON(b []byte) error

+ func (r Embed) MarshalJSON() ([]byte, error)

+ type Indexer interface

+ Index func() string

+ type Kind string

+ func KindOf(typ reflect.Type) (Kind, error)

+ func KindOfT[T any]() (Kind, error)

+ func (k Kind) String() string

+ type Meta struct

+ CreatedAt int64

+ CreatedBy string

+ ID string

+ Kind Kind

+ Namespace string

+ State string

+ UpdatedAt int64

+ UpdatedBy string

+ func (r *Meta) Created() (string, time.Time)

+ func (r *Meta) Status() string

+ func (r *Meta) Title() string

+ func (r *Meta) URN() URN

+ func (r *Meta) Updated() (string, time.Time)

+ type Namespace struct

+ Desc string

+ Label string

+ Name string

+ func (n *Namespace) Subtitle() string

+ func (n *Namespace) Title() string

+ type Object interface

+ Created func() (string, time.Time)

+ Status func() string

+ URN func() URN

+ Updated func() (string, time.Time)

+ func FromJSON(c Registry, data []byte) (Object, error)

+ func FromKind(c Registry, kind Kind) (Object, error)

+ func NewByType(typ reflect.Type, namespace string) (Object, error)

+ func NewByURN(c Registry, urn URN) (Object, error)

+ func ReadJSON(c Registry, reader io.Reader) (Object, error)

+ type Options struct

+ Icon string

+ Plural string

+ Sort string

+ Title string

+ type Path string

+ func (p Path) ID(prefix string) string

+ func (p Path) Index() int

+ func (p Path) Label() string

+ func (p Path) String() string

+ func (p Path) Walk() iter.Seq[Path]

+ type Query struct

+ Filters map[string][]string

+ Indexes []string

+ Limit int

+ Match string

+ Namespace string

+ Offset int

+ SortBy []string

+ States []string

+ func ParseQuery(queryString string, object any, out Query) (Query, error)

+ func (q *Query) String() string

+ type Registry interface

+ Register func(Type) error

+ Resolve func(Kind) (Type, error)

+ Types func() iter.Seq[Type]

+ func NewRegistry() Registry

+ type Storage interface

+ Count func(kind Kind, query Query) (int, error)

+ Delete func(urn URN, deletedBy string) (Object, error)

+ Fetch func(urn URN) (Object, error)

+ Insert func(v Object, createdBy string) (Object, error)

+ Search func(kind Kind, query Query) (iter.Seq[Object], error)

+ Update func(v Object, updatedBy string) (Object, error)

+ Upsert func(v Object, updatedBy string) (Object, error)

+ type Type struct

+ Kind Kind

+ Type reflect.Type

+ func Register[T Object](c Registry, opts ...Options) (Type, error)

+ func (t *Type) Field(path Path) (reflect.StructField, bool)

+ type URN struct

+ ID string

+ Kind Kind

+ Namespace string

+ func NewURN(namespace string, kind Kind) (URN, error)

+ func ParseURN(s string) (URN, error)

+ func (u *URN) UnmarshalJSON(b []byte) error

+ func (u URN) IsValid() bool

+ func (u URN) MarshalJSON() ([]byte, error)

+ func (u URN) String() string