cy

Documentation

Index

• Variables
• type Client
  • func (c *Client) Attach(node tree.Node) error
  • func (c *Client) Detach(reason string) error
  • func (c *Client) Node() tree.Node
  • func (c *Client) Resize(size geom.Vec2)
• type CmdParams
• type Connection
• type Cy
  • func Start(ctx context.Context, options Options) (*Cy, error)
  • func (c *Cy) HandleWSClient(conn ws.Client[P.Message])
  • func (c *Cy) Shutdown() error
• type Options

Variables

var CY_BOOT_FILE []byte

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) Detach

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

func (*Client) Node

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

func (*Client) Resize

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

type CmdParams

type CmdParams struct {
	Command string
	Args    []string
}

type Connection

type Connection = ws.Client[P.Message]

type Cy

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

func Start

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

func (*Cy) HandleWSClient

func (c *Cy) HandleWSClient(conn ws.Client[P.Message])

func (*Cy) Shutdown

func (c *Cy) Shutdown() error

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
}