session

package

v3.12.4 Latest Latest Go to latest Published: Feb 27, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/stateful/runme

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func DiffEnvStores(initial, updated *EnvStoreMap) (newOrUpdated, unchanged, deleted []string)
func NewSessionList() *lru.Cache[*Session]
func SplitEnv(str string) (string, string)
type EnvStore
type EnvStoreMap
- func NewEnvStore() *EnvStoreMap
type Session
- func New(opts ...SessionOption) (*Session, error)
type SessionOption

Constants ¶

View Source

const (
	MaxEnvSizeInBytes     = 128*1024 - 128
	MaxEnvironSizeInBytes = MaxEnvSizeInBytes * 8
)

View Source

const SessionListCapacity = 1024

SessionListCapacity is a maximum number of sessions stored in a single SessionList.

Variables ¶

View Source

var ErrEnvTooLarge = errors.New("env too large")

Functions ¶

func DiffEnvStores ¶

func DiffEnvStores(initial, updated *EnvStoreMap) (newOrUpdated, unchanged, deleted []string)

func NewSessionList ¶

func NewSessionList() *lru.Cache[*Session]

func SplitEnv ¶

func SplitEnv(str string) (string, string)

Types ¶

type EnvStore ¶

type EnvStore interface {
	Load(source string, envs ...string) error
	Merge(ctx context.Context, envs ...string) error
	Get(k string) (string, bool)
	Set(ctx context.Context, k, v string) error
	Delete(ctx context.Context, k string) error
	Items() ([]string, error)
}

type EnvStoreMap ¶

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

func NewEnvStore ¶

func NewEnvStore() *EnvStoreMap

func (*EnvStoreMap) Delete ¶

func (s *EnvStoreMap) Delete(ctx context.Context, k string) error

func (*EnvStoreMap) Get ¶

func (s *EnvStoreMap) Get(k string) (string, bool)

func (*EnvStoreMap) Items ¶

func (s *EnvStoreMap) Items() ([]string, error)

func (*EnvStoreMap) Load ¶

func (s *EnvStoreMap) Load(source string, envs ...string) error

func (*EnvStoreMap) Merge ¶

func (s *EnvStoreMap) Merge(ctx context.Context, envs ...string) error

func (*EnvStoreMap) Set ¶

func (s *EnvStoreMap) Set(ctx context.Context, k, v string) error

type Session ¶

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

Session is an object which lifespan contains multiple executions. It's used to exchange information between executions. Currently, it only keeps track of environment variables.

func New ¶

func New(opts ...SessionOption) (*Session, error)

func New(owl bool, proj *project.Project, seedEnv []string) (*Session, error) {

func (*Session) DeleteEnv ¶

func (s *Session) DeleteEnv(ctx context.Context, keys ...string) error

func (*Session) GetAllEnv ¶

func (s *Session) GetAllEnv() []string

func (*Session) GetEnv ¶

func (s *Session) GetEnv(key string) (string, bool)

func (*Session) Identifer ¶ added in v3.12.3

func (s *Session) Identifer() string

func (*Session) SetEnv ¶

func (s *Session) SetEnv(ctx context.Context, env ...string) error

type SessionOption ¶

type SessionOption func(*sessionFactory) *sessionFactory

func WithOwl ¶

func WithOwl(owl bool) SessionOption

func WithProject ¶

func WithProject(proj *project.Project) SessionOption

func WithSeedEnv ¶

func WithSeedEnv(seedEnv []string) SessionOption

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL