shell

package

v1.0.2 Latest Latest Go to latest Published: May 4, 2023 License: Apache-2.0 Imports: 5 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

This section is empty.

This section is empty.

func DecodeResponse(res string) (any, error)

DecodeResponse decodes a shell response string to a JSON response.

func ResponseToJSONString(res string) string

ResponseToJSONString converts a shell response string to a JSON string.

func UnmarshalResponse(res string, to any) (any, error)

UnmarshalResponse unmarshals a shell response string to a JSON response.

type Client struct {
	*Config
}

func NewClient() *Client

NewClient returns a shell client instance.

func (client *Client) Close() error

Close closes the database.

func (client *Client) Open() error

Open opens a database specified by the internal configuration.

func (client *Client) Query(query string) (any, error)

Query executes a query and returns a result.

type Config struct {
	Host string
	Port int
}

Config stores server configuration parammeters.

func NewDefaultConfig() *Config

NewDefaultConfig returns a default configuration instance.

func (config *Config) SetHost(host string)

SetHost sets a host address.

func (config *Config) SetPort(port int)

SetPort sets a listen port.