client

package

v1.0.0 Latest Latest Go to latest Published: Dec 19, 2021 License: MPL-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/antonio-alexander/go-bludgeon

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Files(pwd string) (configFile, cacheFile string, err error)
func Main(pwd string, args []string, envs map[string]string) error
type Client
type CommandData
type Configuration
- func NewConfiguration() *Configuration
type Meta
type SerializedData

Constants ¶

View Source

const (
	ErrUnsupportedConfigf     string        = "unsupported Type: %T"
	ErrMetaNotFoundf          string        = "meta not found: %s"
	ErrRemoteNotFoundf        string        = "meta not found: %s"
	EnvNameBludgeonMetaType   string        = "BLUDGEON_META_TYPE"
	EnvNameBludgeonClientType string        = "BLUDGEON_REMOTE_TYPE"
	EnvNameBludgeonAddress    string        = "BLUDGEON_ADDRESS"
	EnvNameBludgeonPort       string        = "BLUDGEON_PORT"
	EnvNameBluderonTimeout    string        = "BLUDGEON_TIMEOUT"
	DefaultMetaType           meta.Type     = meta.TypeFile
	DefaultClientType         client.Type   = client.TypeRest
	DefaultAddress            string        = "127.0.0.1"
	DefaultPort               string        = "8080"
	DefaultTimeout            time.Duration = 10 * time.Second
)

data constants

View Source

const (
	DefaultFolder            = ".bludgeon"
	DefaultConfigurationFile = "config/bludgeon_config.json"
	DefaultCacheFile         = "data/bludgeon_cache.json"
)

View Source

const (
	ErrStarted    string = "client started"
	ErrNotStarted string = "client not started"
)

error constants

Variables ¶

View Source

var (
	Version   string
	GitCommit string
	GitBranch string
)

These variables are populated at build time REFERENCE: https://www.digitalocean.com/community/tutorials/using-ldflags-to-set-version-information-for-go-applications to find where the variables are...

go tool nm ./app | grep app

Functions ¶

func Files ¶

func Files(pwd string) (configFile, cacheFile string, err error)

func Main ¶

func Main(pwd string, args []string, envs map[string]string) error

Types ¶

type Client ¶

type Client struct {
	Type client.Type
	Rest *rest.Configuration
}

type CommandData ¶

type CommandData struct {
	ID         string
	StartTime  time.Time
	FinishTime time.Time
	PauseTime  time.Time
}

type Configuration ¶

type Configuration struct {
	Client Client
	Meta   Meta
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) Default ¶

func (c *Configuration) Default(pwd string)

func (*Configuration) FromEnv ¶

func (c *Configuration) FromEnv(pwd string, envs map[string]string) (err error)

func (*Configuration) Read ¶

func (c *Configuration) Read(configPath, pwd string, envs map[string]string) error

func (*Configuration) Validate ¶

func (c *Configuration) Validate() (err error)

func (*Configuration) Write ¶

func (c *Configuration) Write(configPath string) error

type Meta ¶

type Meta struct {
	Type meta.Type
	File *metafile.Configuration
}

type SerializedData ¶

type SerializedData struct {
}

SerializedData

Source Files ¶

View all Source files

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