Skip to content

Expose GetBytes, GetAny, and SetBytes on session.Provider #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 3, 2023
Merged

Expose GetBytes, GetAny, and SetBytes on session.Provider #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion session/session.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,26 @@ import "net/http"
// _ = sess.SetString("idp.authenticated", "true")
// _ = sess.Save()
type Provider interface {
// GetString returns a session value based on the provided key.
// GetString returns a session value based on the provided key. If the key does
// not exist, the default or zero value will be returned (i.e, "").
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we start returning errors 😉 ? Like ErrNotFound and make that available in this pacakge?

GetString(key string) (string, error)

// GetBytes returns the []byte for a given key from the session data. If the key
// does not exist, the default or zero value will be returned (i.e, nil).
GetBytes(key string) ([]byte, error)

// GetAny returns a session value based the provided key. If the key does not
// exist, the default or zero value will be returned (i.e, nil). This method is
// mainly exposed for backwards compatibility any may be deprecated in the
// future.
GetAny(key string) (any, error)

// SetString adds a key and the corresponding string value to the session data.
SetString(key string, value string) error

// SetBytes adds a key and the corresponding []byte value to the session data.
SetBytes(key string, value []byte) error

// Save saves all changes from the changelog to the underlying session store.
Save() error
}
Expand Down