session

Documentation

Overview

Package session contains methods and objects for managing user sessions.

Index

• func Clear(ctx context.Context) error
• func LoadAndSave(next http.Handler) http.Handler
• func NewSessionManager() error
• func Renew(ctx context.Context) error
• func Restore[T any](ctx context.Context, key string) (T, error)
• func Save[T any](ctx context.Context, key string, obj T)

Functions

func Clear

func Clear(ctx context.Context) error

Clear deletes the session data from the session store and sets the session status to Destroyed. Any further operations in the same request cycle will result in a new session being created.

func LoadAndSave

func LoadAndSave(next http.Handler) http.Handler

LoadAndSave middleware handles loading the session data for a request and saving any modifications.

func NewSessionManager

func NewSessionManager() error

NewSessionManager creates a new session manager.

func Renew

func Renew(ctx context.Context) error

Renew updates the session data to have a new session token while retaining the current session data. The session lifetime is also reset and the session data status will be set to Modified. The old session token and accompanying data are deleted from the session store.

func Restore

func Restore[T any](ctx context.Context, key string) (T, error)

Restore retrieves an object from the session storage with the given key. If the object cannot be retrieved, then the defaultFunc is used to generate a new default value.

func Save

func Save[T any](ctx context.Context, key string, obj T)

Save saves the given object to the session storage with the given key.