gsr

README

GSR

Go Standards Recommendations

Install

go get github.com/gookit/gsr

Interfaces

• logger
• cacher
• parser

Usage

Logger Interface

Std Logger

package main
import (
	"github.com/gookit/gsr"
)

type MyApp struct {
	logger gsr.StdLogger // std logger
}

func (ma *MyApp) SetLogger(logger gsr.StdLogger)  {
	ma.logger = logger
}

Full Logger

package main
import (
	"github.com/gookit/gsr"
)

type MyApp struct {
	logger gsr.Logger // full logger
}

func (ma *MyApp) SetLogger(logger gsr.Logger)  {
	ma.logger = logger
}

Cache Interface

Simple Cache

package main
import (
	"github.com/gookit/gsr"
)

type MyApp struct {
	cacher gsr.SimpleCacher
}

func (ma *MyApp) SetCacher(cacher gsr.SimpleCacher)  {
	ma.cacher = cacher
}

DataParser interface

// DataParser interface for Marshal/Unmarshal data
type DataParser interface {
	Marshal(v any) ([]byte, error)
	Unmarshal(data []byte, ptr any) error
}

LICENSE

MIT

Documentation

Overview

Package gsr is the Go standards recommendations interface definitions.

Source code and other details for the project are available at GitHub:

https://github.com/gookit/gsr

Index

• type CodedCacher
• type ContextCacher
• type ContextOpCacher
• type DataParser
• type GenLogger
• type Logger
• type MarshalFunc
  • func (m MarshalFunc) Marshal(v any) ([]byte, error)
• type Marshaler
• type Printer
• type SimpleCacher
• type StdLogger
• type UnmarshalFunc
  • func (u UnmarshalFunc) Unmarshal(v []byte, ptr any) error
• type Unmarshaler

Types

type CodedCacher

type CodedCacher interface {
	SimpleCacher

	// GetAs get and decode cache value to object ptr
	GetAs(key string, ptr any) error
}

CodedCacher interface.

type ContextCacher

type ContextCacher interface {
	SimpleCacher
	// WithContext and clone new cacher
	WithContext(ctx context.Context) ContextCacher
}

ContextCacher interface.

type ContextOpCacher

type ContextOpCacher interface {
	SimpleCacher

	// HasWithCtx basic operation
	HasWithCtx(ctx context.Context, key string) bool
	DelWithCtx(ctx context.Context, key string) error
	GetWithCtx(ctx context.Context, key string) any
	SetWithCtx(ctx context.Context, key string, val any, ttl time.Duration) error

	// MGetWithCtx multi keys operation
	MGetWithCtx(ctx context.Context, keys []string) map[string]any
	MSetWithCtx(ctx context.Context, values map[string]any, ttl time.Duration) error
	MDelWithCtx(ctx context.Context, keys []string) error
}

ContextOpCacher interface.

type DataParser

type DataParser interface {
	Marshaler
	Unmarshaler
}

DataParser interface for Marshal/Unmarshal data

type GenLogger

type GenLogger interface {
	Debug(v ...any)
	Debugf(format string, v ...any)
	Info(v ...any)
	Infof(format string, v ...any)
	Warn(v ...any)
	Warnf(format string, v ...any)
	Error(v ...any)
	Errorf(format string, v ...any)
}

GenLogger generic logger interface definition

type Logger

type Logger interface {
	StdLogger
	GenLogger
}

Logger interface definition

type MarshalFunc

type MarshalFunc func(v any) ([]byte, error)

MarshalFunc define

func (MarshalFunc) Marshal

func (m MarshalFunc) Marshal(v any) ([]byte, error)

Marshal implements the Marshaler

type Marshaler

type Marshaler interface {
	Marshal(v any) ([]byte, error)
}

Marshaler interface

type Printer

type Printer interface {
	Print(v ...any)
	Printf(format string, v ...any)
	Println(v ...any)
}

Printer interface definition

type SimpleCacher

type SimpleCacher interface {
	// Closer close cache handle
	io.Closer
	// Clear all cache data
	Clear() error

	// Has basic operation
	Has(key string) bool
	Del(key string) error
	Get(key string) any
	Set(key string, val any, ttl time.Duration) error

	// GetMulti multi operation
	GetMulti(keys []string) map[string]any
	SetMulti(values map[string]any, ttl time.Duration) error
	DelMulti(keys []string) error
}

SimpleCacher interface definition

type StdLogger

type StdLogger interface {
	Printer
	Fatal(v ...any)
	Fatalf(format string, v ...any)
	Fatalln(v ...any)
	Panic(v ...any)
	Panicf(format string, v ...any)
	Panicln(v ...any)
}

StdLogger interface definition. refer the go "log" package.

type UnmarshalFunc

type UnmarshalFunc func(v []byte, ptr any) error

UnmarshalFunc define

func (UnmarshalFunc) Unmarshal

func (u UnmarshalFunc) Unmarshal(v []byte, ptr any) error

Unmarshal implements the Unmarshaler

type Unmarshaler

type Unmarshaler interface {
	Unmarshal(v []byte, ptr any) error
}

Unmarshaler interface