loreddev/x
1
0
Fork 0
Code Issues Pull Requests Activity

docs(blogo,metadata): top-level functions documentation

Browse Source
This commit is contained in:
Guz
2025-01-24 16:40:33 -03:00
parent cf469b2586
commit df2d1ca52e
1 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
blogo/metadata/metadata.go
View File

@@ -32,6 +32,13 @@ var (
ErrNoMetadata = errors.New("type does not implement or has metadata") ErrNoMetadata = errors.New("type does not implement or has metadata")
) )
// Gets a value from a [Metadata] or [WithMetadata] objects and tries
// to convert it to the specified type. If m implements [TypedMetadata],
// tries to use the typed methods directly.
//
// For more information, see [Get].
//
// If the value is not of the specified type, returns [ErrInvalidType].
func GetTyped[T any](m any, key string) (T, error) { func GetTyped[T any](m any, key string) (T, error) {
var z T var z T
@@ -117,6 +124,11 @@ func getTypedFromTyped[T any](m TypedMetadata, key string) (any, error) {
} }
} }
// Gets a value from m, if it implements [Metadata] or [WithMetadata], otherwise returns
// [ErrNoMetadata].
//
// If there is metadata, but there isn't any value associated with the specified key,
// returns [ErrNotFound]. More information at [Metadata]'s Get method.
func Get(m any, key string) (any, error) { func Get(m any, key string) (any, error) {
data, err := GetMetadata(m) data, err := GetMetadata(m)
if err != nil { if err != nil {
@@ -125,6 +137,11 @@ func Get(m any, key string) (any, error) {
return data.Get(key) return data.Get(key)
} }
// Sets a value of m, if it implements [Metadata] or [WithMetadata], otherwise returns
// otherwise returns [ErrNoMetadata].
//
// If the underlying metadata is [Immutable], returns [ErrImmutable]. See [Metadata]'s
// Set method for more information.
func Set(m any, key string, v any) error { func Set(m any, key string, v any) error {
data, err := GetMetadata(m) data, err := GetMetadata(m)
if err != nil { if err != nil {
@@ -133,6 +150,11 @@ func Set(m any, key string, v any) error {
return data.Set(key, v) return data.Set(key, v)
} }
// Deletes a value of m, if it implements [Metadata] or [WithMetadata], otherwise returns
// otherwise returns [ErrNoMetadata].
//
// If the underlying metadata is [Immutable], returns [ErrImmutable]. See [Metadata]'s
// Delete method for more information.
func Delete(m any, key string) error { func Delete(m any, key string) error {
data, err := GetMetadata(m) data, err := GetMetadata(m)
if err != nil { if err != nil {
@@ -141,6 +163,10 @@ func Delete(m any, key string) error {
return data.Delete(key) return data.Delete(key)
} }
// Gets the underlying [Metadata] of m. If m implements [Metadata], returns it unchanged,
// otherwise uses the Metadata method if it implements [WithMetadata].
//
// If m doesn't implement any of the interfaces, returns [ErrNoMetadata].
func GetMetadata(m any) (Metadata, error) { func GetMetadata(m any) (Metadata, error) {
var data Metadata var data Metadata