cy

package

v0.1.12 Latest Latest Go to latest Published: Feb 9, 2024 License: MIT Imports: 32 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/cfoust/cy

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Client
type ClientID
type ClientOptions
type Cy
- func Start(ctx context.Context, options Options) (*Cy, error)
- func (c *Cy) NewClient(ctx context.Context, options ClientOptions) (*Client, error)
- func (c *Cy) Shutdown() error
type CyModule
type Environment
type Options
type ToastLogger
- func NewToastLogger(send func(toasts.Toast)) *ToastLogger

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	KEYWORD_INFO  = janet.Keyword("info")
	KEYWORD_WARN  = janet.Keyword("warn")
	KEYWORD_ERROR = janet.Keyword("error")
)

View Source

var CY_BOOT_FILE []byte

View Source

var DOCS_CY string

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	deadlock.RWMutex
	util.Lifetime
	// contains filtered or unexported fields
}

func (*Client) Attach ¶

func (c *Client) Attach(node tree.Node) error

func (*Client) Binds ¶ added in v0.1.11

func (c *Client) Binds() (binds []api.Binding)

func (*Client) Detach ¶

func (c *Client) Detach(reason string) error

func (*Client) Frame ¶ added in v0.1.6

func (c *Client) Frame() *frames.Framer

func (*Client) Get ¶ added in v0.1.10

func (c *Client) Get(key string) (value interface{}, ok bool)

func (*Client) Margins ¶ added in v0.1.6

func (c *Client) Margins() *screen.Margins

func (*Client) Node ¶

func (c *Client) Node() tree.Node

func (*Client) OuterLayers ¶ added in v0.1.6

func (c *Client) OuterLayers() *screen.Layers

func (*Client) Params ¶ added in v0.1.6

func (c *Client) Params() *params.Parameters

func (*Client) Read ¶ added in v0.1.10

func (c *Client) Read(p []byte) (n int, err error)

func (*Client) Resize ¶

func (c *Client) Resize(size geom.Vec2) error

func (*Client) Write ¶ added in v0.1.10

func (c *Client) Write(data []byte) (n int, err error)

type ClientID ¶ added in v0.1.6

type ClientID = int32

type ClientOptions ¶ added in v0.1.10

type ClientOptions = P.HandshakeMessage

type Cy ¶

type Cy struct {
	util.Lifetime
	deadlock.RWMutex
	*janet.VM
	// contains filtered or unexported fields
}

func Start ¶

func Start(ctx context.Context, options Options) (*Cy, error)

func (*Cy) NewClient ¶ added in v0.1.10

func (c *Cy) NewClient(ctx context.Context, options ClientOptions) (*Client, error)

func (*Cy) Shutdown ¶

func (c *Cy) Shutdown() error

type CyModule ¶ added in v0.1.6

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

func (*CyModule) Detach ¶ added in v0.1.6

func (c *CyModule) Detach(user interface{})

func (*CyModule) Documentation ¶ added in v0.1.6

func (i *CyModule) Documentation() string

func (*CyModule) Get ¶ added in v0.1.6

func (c *CyModule) Get(user interface{}, key *janet.Value) (interface{}, error)

func (*CyModule) KillServer ¶ added in v0.1.6

func (c *CyModule) KillServer()

func (*CyModule) Log ¶ added in v0.1.6

func (c *CyModule) Log(level *janet.Value, text string) error

func (*CyModule) Paste ¶ added in v0.1.6

func (c *CyModule) Paste(user interface{})

func (*CyModule) Replay ¶ added in v0.1.6

func (c *CyModule) Replay(user interface{})

func (*CyModule) Set ¶ added in v0.1.6

func (c *CyModule) Set(user interface{}, key *janet.Value, value *janet.Value) error

func (*CyModule) Toast ¶ added in v0.1.6

func (c *CyModule) Toast(context interface{}, level *janet.Value, message string) error

type Environment ¶ added in v0.1.6

type Environment map[string]string

func (Environment) Default ¶ added in v0.1.6

func (e Environment) Default(key string, defaultValue string) string

func (Environment) Get ¶ added in v0.1.6

func (e Environment) Get(key string) (string, bool)

func (Environment) IsSet ¶ added in v0.1.6

func (e Environment) IsSet(key string) bool

type Options ¶

type Options struct {
	// The initial Janet script, typically ~/.cyrc.janet.
	Config string
	// The default directory in which to store data (e.g. recorded sessions).
	DataDir string
	// The default shell
	Shell string
	// Whether to show the splash screen on client join
	HideSplash bool
}

type ToastLogger ¶ added in v0.1.5

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

func NewToastLogger ¶ added in v0.1.5

func NewToastLogger(send func(toasts.Toast)) *ToastLogger

func (*ToastLogger) Error ¶ added in v0.1.5

func (t *ToastLogger) Error(msg string)

func (*ToastLogger) Info ¶ added in v0.1.5

func (t *ToastLogger) Info(msg string)

func (*ToastLogger) Send ¶ added in v0.1.5

func (t *ToastLogger) Send(toast toasts.Toast)

func (*ToastLogger) Warn ¶ added in v0.1.5

func (t *ToastLogger) Warn(msg string)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
api
cmd
params

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