state

package

Go to main page

Versions in this module

v0

v0.13.1

Feb 4, 2023

v0.13.0

Jan 26, 2023

v0.12.3

Jan 17, 2023

v0.12.2

Jan 5, 2023

v0.12.1

Jan 3, 2023

v0.12.0

Dec 19, 2022

Changes in this version

+ var ErrorFileNotFound = errors.New("not found")

+ func BucketAndPath(u *url.URL) (string, string)

+ type GCSHandler struct

+ func NewGCSHandler(client *storage.Client, u *url.URL) (*GCSHandler, error)

+ type GCSObjectStorage struct

+ Client *storage.Client

+ func (s *GCSObjectStorage) GetObject(ctx context.Context, bucket, key string) (*GetObjectResponse, error)

+ func (s *GCSObjectStorage) PutObject(ctx context.Context, bucket, key string, body io.Reader) error

+ type GetObjectResponse struct

+ Body io.ReadCloser

+ type JSONState map[string]StateValueJSON

+ type ObjectStorage interface

+ GetObject func(ctx context.Context, bucket, key string) (*GetObjectResponse, error)

+ PutObject func(ctx context.Context, bucket, key string, body io.Reader) error

+ type ObjectStorageHandler struct

+ BasePath string

+ Bucket string

+ Storage ObjectStorage

+ func NewObjectStorageHandler(storage ObjectStorage, bucket, base string) *ObjectStorageHandler

+ func (s *ObjectStorageHandler) Exists(ctx context.Context, arg Argument) (bool, error)

+ func (s *ObjectStorageHandler) GetBool(ctx context.Context, arg Argument) (bool, error)

+ func (s *ObjectStorageHandler) GetDirectory(ctx context.Context, arg Argument) (fs.FS, error)

+ func (s *ObjectStorageHandler) GetDirectoryString(ctx context.Context, arg Argument) (string, error)

+ func (s *ObjectStorageHandler) GetFile(ctx context.Context, arg Argument) (*os.File, error)

+ func (s *ObjectStorageHandler) GetFloat64(ctx context.Context, arg Argument) (float64, error)

+ func (s *ObjectStorageHandler) GetInt64(ctx context.Context, arg Argument) (int64, error)

+ func (s *ObjectStorageHandler) GetString(ctx context.Context, arg Argument) (string, error)

+ func (s *ObjectStorageHandler) SetBool(ctx context.Context, arg Argument, value bool) error

+ func (s *ObjectStorageHandler) SetDirectory(ctx context.Context, arg Argument, path string) error

+ func (s *ObjectStorageHandler) SetFile(ctx context.Context, arg Argument, path string) error

+ func (s *ObjectStorageHandler) SetFileReader(ctx context.Context, arg Argument, r io.Reader) (string, error)

+ func (s *ObjectStorageHandler) SetFloat64(ctx context.Context, arg Argument, value float64) error

+ func (s *ObjectStorageHandler) SetInt64(ctx context.Context, arg Argument, value int64) error

+ func (s *ObjectStorageHandler) SetString(ctx context.Context, arg Argument, value string) error

+ type S3Handler struct

+ func NewS3Handler(client *s3.Client, u *url.URL) (*S3Handler, error)

+ type S3ObjectStorage struct

+ Client *s3.Client

+ func (s *S3ObjectStorage) GetObject(ctx context.Context, bucket, key string) (*GetObjectResponse, error)

+ func (s *S3ObjectStorage) PutObject(ctx context.Context, bucket, key string, body io.Reader) error

v0.11.1

Dec 12, 2022

Changes in this version

+ func ArgListContains(args Arguments, arg Argument) bool

v0.11.0

Dec 11, 2022

Changes in this version

+ func EqualArgs(a []Argument, b []Argument) bool

+ func GetValueAsString(r Reader, arg Argument) (string, error)

+ func MustGetBool(s Handler, arg Argument) bool

+ func MustGetDirectory(s Handler, arg Argument) fs.FS

+ func MustGetDirectoryString(s Handler, arg Argument) string

+ func MustGetFile(s Handler, arg Argument) *os.File

+ func MustGetFloat64(s Handler, arg Argument) float64

+ func MustGetInt64(s Handler, arg Argument) int64

+ func MustGetString(s Handler, arg Argument) string

+ func SetValueFromJSON(w Writer, value StateValueJSON) error

type Argument

+ func Without(args []Argument, exclude []Argument) []Argument

+ type Arguments []Argument

+ func (a *Arguments) String() string

+ type Handler interface

+ type HandlerLogWrapper struct

+ func HandlerWithLogs(log logrus.FieldLogger, state Handler) *HandlerLogWrapper

+ type NoOpHandler struct

+ func NewNoOpHandler() *NoOpHandler

+ func (n *NoOpHandler) Exists(arg Argument) (bool, error)

+ func (n *NoOpHandler) GetBool(arg Argument) (bool, error)

+ func (n *NoOpHandler) GetDirectory(arg Argument) (fs.FS, error)

+ func (n *NoOpHandler) GetDirectoryString(arg Argument) (string, error)

+ func (n *NoOpHandler) GetFile(arg Argument) (*os.File, error)

+ func (n *NoOpHandler) GetFloat64(arg Argument) (float64, error)

+ func (n *NoOpHandler) GetInt64(arg Argument) (int64, error)

+ func (n *NoOpHandler) GetString(arg Argument) (string, error)

+ func (n *NoOpHandler) SetBool(arg Argument, val bool) error

+ func (n *NoOpHandler) SetDirectory(arg Argument, dir string) error

+ func (n *NoOpHandler) SetFile(arg Argument, path string) error

+ func (n *NoOpHandler) SetFileReader(arg Argument, r io.Reader) (string, error)

+ func (n *NoOpHandler) SetFloat64(arg Argument, val float64) error

+ func (n *NoOpHandler) SetInt64(arg Argument, val int64) error

+ func (n *NoOpHandler) SetString(arg Argument, val string) error

+ type Observer struct

+ func NewObserver(h Handler) *Observer

+ func (o *Observer) CondFor(arg Argument) *sync.Cond

+ func (o *Observer) Exists(arg Argument) (bool, error)

+ func (o *Observer) GetBool(arg Argument) (bool, error)

+ func (o *Observer) GetDirectory(arg Argument) (fs.FS, error)

+ func (o *Observer) GetDirectoryString(arg Argument) (string, error)

+ func (o *Observer) GetFile(arg Argument) (*os.File, error)

+ func (o *Observer) GetFloat64(arg Argument) (float64, error)

+ func (o *Observer) GetInt64(arg Argument) (int64, error)

+ func (o *Observer) GetString(arg Argument) (string, error)

+ func (o *Observer) Notify(arg Argument)

+ func (o *Observer) SetBool(arg Argument, val bool) error

+ func (o *Observer) SetDirectory(arg Argument, dir string) error

+ func (o *Observer) SetFile(arg Argument, path string) error

+ func (o *Observer) SetFileReader(arg Argument, r io.Reader) (string, error)

+ func (o *Observer) SetFloat64(arg Argument, val float64) error

+ func (o *Observer) SetInt64(arg Argument, val int64) error

+ func (o *Observer) SetString(arg Argument, val string) error

+ type Reader interface

+ Exists func(Argument) (bool, error)

+ GetBool func(Argument) (bool, error)

+ GetDirectory func(Argument) (fs.FS, error)

+ GetDirectoryString func(Argument) (string, error)

+ GetFile func(Argument) (*os.File, error)

+ GetFloat64 func(Argument) (float64, error)

+ GetInt64 func(Argument) (int64, error)

+ GetString func(Argument) (string, error)

+ type ReaderLogWrapper struct

+ Log logrus.FieldLogger

+ func ReaderWithLogs(log logrus.FieldLogger, state Reader) *ReaderLogWrapper

+ func (s *ReaderLogWrapper) Exists(arg Argument) (bool, error)

+ func (s *ReaderLogWrapper) GetDirectory(arg Argument) (fs.FS, error)

+ func (s *ReaderLogWrapper) GetDirectoryString(arg Argument) (string, error)

+ func (s *ReaderLogWrapper) GetFile(arg Argument) (*os.File, error)

+ func (s *ReaderLogWrapper) GetFloat64(arg Argument) (float64, error)

+ func (s *ReaderLogWrapper) GetInt64(arg Argument) (int64, error)

+ func (s *ReaderLogWrapper) GetString(arg Argument) (string, error)

type State

+ func NewDefaultState(log logrus.FieldLogger, pargs *args.PipelineArgs) (*State, error)

+ type StateValueJSON struct

+ Argument Argument

+ Value any

+ type Writer interface

+ SetBool func(Argument, bool) error

+ SetDirectory func(Argument, string) error

+ SetFile func(Argument, string) error

+ SetFileReader func(Argument, io.Reader) (string, error)

+ SetFloat64 func(Argument, float64) error

+ SetInt64 func(Argument, int64) error

+ SetString func(Argument, string) error

+ type WriterLogWrapper struct

+ Log logrus.FieldLogger

+ func WriterWithLogs(log logrus.FieldLogger, state Writer) *WriterLogWrapper

+ func (s *WriterLogWrapper) SetDirectory(arg Argument, val string) error

+ func (s *WriterLogWrapper) SetFile(arg Argument, val string) error

+ func (s *WriterLogWrapper) SetFileReader(arg Argument, val io.Reader) (string, error)

+ func (s *WriterLogWrapper) SetFloat64(arg Argument, val float64) error

+ func (s *WriterLogWrapper) SetInt64(arg Argument, val int64) error

+ func (s *WriterLogWrapper) SetString(arg Argument, val string) error

v0.10.0

Dec 4, 2022

Changes in this version

+ var ErrorEmptyState = errors.New("state is empty")

+ var ErrorKeyExists = errors.New("key already exists in state")

+ var ErrorNotFound = errors.New("key not found in state")

+ var ErrorReadOnly = errors.New("state is read-only")

+ func ArgumentTypesEqual(arg Argument, argTypes ...ArgumentType) bool

+ type ArgMapReader struct

+ func NewArgMapReader(defaults args.ArgMap) *ArgMapReader

+ func (s *ArgMapReader) Exists(arg Argument) (bool, error)

+ func (s *ArgMapReader) GetBool(arg Argument) (bool, error)

+ func (s *ArgMapReader) GetDirectory(arg Argument) (fs.FS, error)

+ func (s *ArgMapReader) GetDirectoryString(arg Argument) (string, error)

+ func (s *ArgMapReader) GetFile(arg Argument) (*os.File, error)

+ func (s *ArgMapReader) GetFloat64(arg Argument) (float64, error)

+ func (s *ArgMapReader) GetInt64(arg Argument) (int64, error)

+ func (s *ArgMapReader) GetString(arg Argument) (string, error)

+ type Argument struct

+ Key string

+ Type ArgumentType

+ func NewBoolArgument(key string) Argument

+ func NewDirectoryArgument(key string) Argument

+ func NewFileArgument(key string) Argument

+ func NewFloat64Argument(key string) Argument

+ func NewInt64Argument(key string) Argument

+ func NewSecretArgument(key string) Argument

+ func NewStringArgument(key string) Argument

+ func NewUnpackagedDirectoryArgument(key string) Argument

+ type ArgumentType int

+ const ArgumentTypeBool

+ const ArgumentTypeFS

+ const ArgumentTypeFile

+ const ArgumentTypeFloat64

+ const ArgumentTypeInt64

+ const ArgumentTypeSecret

+ const ArgumentTypeString

+ const ArgumentTypeUnpackagedFS

+ func (a ArgumentType) String() string

+ type FilesystemState struct

+ func NewFilesystemState(path string) (*FilesystemState, error)

+ func (f *FilesystemState) Exists(arg Argument) (bool, error)

+ func (f *FilesystemState) GetBool(arg Argument) (bool, error)

+ func (f *FilesystemState) GetDirectory(arg Argument) (fs.FS, error)

+ func (f *FilesystemState) GetDirectoryString(arg Argument) (string, error)

+ func (f *FilesystemState) GetFile(arg Argument) (*os.File, error)

+ func (f *FilesystemState) GetFloat64(arg Argument) (float64, error)

+ func (f *FilesystemState) GetInt64(arg Argument) (int64, error)

+ func (f *FilesystemState) GetString(arg Argument) (string, error)

+ func (f *FilesystemState) SetBool(arg Argument, value bool) error

+ func (f *FilesystemState) SetDirectory(arg Argument, value string) error

+ func (f *FilesystemState) SetFile(arg Argument, value string) error

+ func (f *FilesystemState) SetFileReader(arg Argument, value io.Reader) error

+ func (f *FilesystemState) SetFloat64(arg Argument, value float64) error

+ func (f *FilesystemState) SetInt64(arg Argument, value int64) error

+ func (f *FilesystemState) SetString(arg Argument, value string) error

+ type State struct

+ Fallback []StateReader

+ Handler StateHandler

+ Log logrus.FieldLogger

+ func (s *State) Exists(arg Argument) (bool, error)

+ func (s *State) GetBool(arg Argument) (bool, error)

+ func (s *State) GetDirectory(arg Argument) (fs.FS, error)

+ func (s *State) GetDirectoryString(arg Argument) (string, error)

+ func (s *State) GetFile(arg Argument) (*os.File, error)

+ func (s *State) GetFloat64(arg Argument) (float64, error)

+ func (s *State) GetInt64(arg Argument) (int64, error)

+ func (s *State) GetString(arg Argument) (string, error)

+ func (s *State) MustGetBool(arg Argument) bool

+ func (s *State) MustGetDirectory(arg Argument) fs.FS

+ func (s *State) MustGetDirectoryString(arg Argument) string

+ func (s *State) MustGetFile(arg Argument) *os.File

+ func (s *State) MustGetFloat64(arg Argument) float64

+ func (s *State) MustGetInt64(arg Argument) int64

+ func (s *State) MustGetString(arg Argument) string

+ func (s *State) SetBool(arg Argument, value bool) error

+ func (s *State) SetDirectory(arg Argument, path string) error

+ func (s *State) SetFile(arg Argument, path string) error

+ func (s *State) SetFileReader(arg Argument, r io.Reader) error

+ func (s *State) SetFloat64(arg Argument, value float64) error

+ func (s *State) SetInt64(arg Argument, value int64) error

+ func (s *State) SetString(arg Argument, value string) error

+ type StateHandler interface

+ type StateHandlerLogWrapper struct

+ func StateHandlerWithLogs(log logrus.FieldLogger, state StateHandler) *StateHandlerLogWrapper

+ type StateReader interface

+ Exists func(Argument) (bool, error)

+ GetBool func(Argument) (bool, error)

+ GetDirectory func(Argument) (fs.FS, error)

+ GetDirectoryString func(Argument) (string, error)

+ GetFile func(Argument) (*os.File, error)

+ GetFloat64 func(Argument) (float64, error)

+ GetInt64 func(Argument) (int64, error)

+ GetString func(Argument) (string, error)

+ type StateReaderLogWrapper struct

+ Log logrus.FieldLogger

+ func StateReaderWithLogs(log logrus.FieldLogger, state StateReader) *StateReaderLogWrapper

+ func (s *StateReaderLogWrapper) Exists(arg Argument) (bool, error)

+ func (s *StateReaderLogWrapper) GetDirectory(arg Argument) (fs.FS, error)

+ func (s *StateReaderLogWrapper) GetDirectoryString(arg Argument) (string, error)

+ func (s *StateReaderLogWrapper) GetFile(arg Argument) (*os.File, error)

+ func (s *StateReaderLogWrapper) GetFloat64(arg Argument) (float64, error)

+ func (s *StateReaderLogWrapper) GetInt64(arg Argument) (int64, error)

+ func (s *StateReaderLogWrapper) GetString(arg Argument) (string, error)

+ type StateWriter interface

+ SetBool func(Argument, bool) error

+ SetDirectory func(Argument, string) error

+ SetFile func(Argument, string) error

+ SetFileReader func(Argument, io.Reader) error

+ SetFloat64 func(Argument, float64) error

+ SetInt64 func(Argument, int64) error

+ SetString func(Argument, string) error

+ type StateWriterLogWrapper struct

+ Log logrus.FieldLogger

+ func StateWriterWithLogs(log logrus.FieldLogger, state StateWriter) *StateWriterLogWrapper

+ func (s *StateWriterLogWrapper) SetDirectory(arg Argument, val string) error

+ func (s *StateWriterLogWrapper) SetFile(arg Argument, val string) error

+ func (s *StateWriterLogWrapper) SetFileReader(arg Argument, val io.Reader) error

+ func (s *StateWriterLogWrapper) SetFloat64(arg Argument, val float64) error

+ func (s *StateWriterLogWrapper) SetInt64(arg Argument, val int64) error

+ func (s *StateWriterLogWrapper) SetString(arg Argument, val string) error

+ type StdinReader struct

+ func NewStdinReader(in io.Reader, out io.Writer) *StdinReader

+ func (s *StdinReader) Exists(arg Argument) (bool, error)

+ func (s *StdinReader) Get(arg Argument) (string, error)

+ func (s *StdinReader) GetBool(arg Argument) (bool, error)

+ func (s *StdinReader) GetDirectory(arg Argument) (fs.FS, error)

+ func (s *StdinReader) GetDirectoryString(arg Argument) (string, error)

+ func (s *StdinReader) GetFile(arg Argument) (*os.File, error)

+ func (s *StdinReader) GetFloat64(arg Argument) (float64, error)

+ func (s *StdinReader) GetInt64(arg Argument) (int64, error)

+ func (s *StdinReader) GetString(arg Argument) (string, error)

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