session

README

session

Session handler

Documentation

Index

• Variables
• type Config
• type Handler
  • func New(options *Options) (*Handler, error)
  • func (h *Handler) Get(id string) (*Session, error)
  • func (h *Handler) New() (*Session, error)
• type Options
  • func DefaultOptions(config *Config) *Options
  • func (o *Options) WithDataStore(value datastore.Handler) *Options
  • func (o *Options) WithLogger(value *zap.Logger) *Options
• type Session
  • func (s *Session) Get(key string) (interface{}, error)
  • func (s *Session) Id() string
  • func (s *Session) Set(key string, value interface{}) error

Variables

var (
	ErrNotFound = errors.New("not found")
)

Errors

var (
	ErrSessionNotFound = errors.New("session not found")
)

Errors

Types

type Config

type Config struct {
	KeyLength int    `kong:"prefix='session-',default='32',help='Length of session key',hidden=''"`
	Encoding  string `kong:"prefix='session-',default='base64',enum='none,base64',help='Encoding'"`
}

Config values for session management

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

Handler is used to handle sessions

func New

func New(options *Options) (*Handler, error)

New instantiates a session generator

func (*Handler) Get

func (h *Handler) Get(id string) (*Session, error)

func (*Handler) New

func (h *Handler) New() (*Session, error)

New Creates a new session with a random id

type Options

type Options struct {
	// contains filtered or unexported fields
}

func DefaultOptions

func DefaultOptions(config *Config) *Options

func (*Options) WithDataStore

func (o *Options) WithDataStore(value datastore.Handler) *Options

WithDataStore sets the datastore for the server

func (*Options) WithLogger

func (o *Options) WithLogger(value *zap.Logger) *Options

WithLogger sets the logger for the server

type Session

type Session struct {
	// contains filtered or unexported fields
}

func (*Session) Get

func (s *Session) Get(key string) (interface{}, error)

func (*Session) Id

func (s *Session) Id() string

func (*Session) Set

func (s *Session) Set(key string, value interface{}) error