api

package

v0.1.5 Latest Latest Go to latest Published: Nov 2, 2023 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cfoust/cy

Links

Open Source Insights

Documentation ¶

Index ¶

type Client
type Cmd
- func (c *Cmd) New(groupId tree.NodeID, path string, params *janet.Named[CmdParams]) (tree.NodeID, error)
- func (c *Cmd) Path(id tree.NodeID) (*string, error)
type CmdParams
type GroupModule
- func (g *GroupModule) Children(parentId tree.NodeID) ([]tree.NodeID, error)
- func (g *GroupModule) New(parentId tree.NodeID, params *janet.Named[NodeParams]) (tree.NodeID, error)
type NodeParams
type PaneModule
- func (p *PaneModule) Attach(context interface{}, id tree.NodeID) error
- func (p *PaneModule) Current(context interface{}) *tree.NodeID
type PathModule
type ReplayModule
type TreeModule

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client interface {
	Attach(tree.Node) error
	Node() tree.Node
}

type Cmd ¶

type Cmd struct {
	Lifetime util.Lifetime
	Tree     *tree.Tree
}

func (*Cmd) New ¶

func (c *Cmd) New(
	groupId tree.NodeID,
	path string,
	params *janet.Named[CmdParams],
) (tree.NodeID, error)

func (*Cmd) Path ¶

func (c *Cmd) Path(id tree.NodeID) (*string, error)

type CmdParams ¶

type CmdParams struct {
	Command string
	Args    []string
	Name    string
}

type GroupModule ¶

type GroupModule struct {
	Tree *tree.Tree
}

func (*GroupModule) Children ¶

func (g *GroupModule) Children(parentId tree.NodeID) ([]tree.NodeID, error)

func (*GroupModule) New ¶

func (g *GroupModule) New(
	parentId tree.NodeID,
	params *janet.Named[NodeParams],
) (tree.NodeID, error)

type NodeParams ¶

type NodeParams struct {
	Name string
}

type PaneModule ¶

type PaneModule struct {
	Tree *tree.Tree
}

func (*PaneModule) Attach ¶

func (p *PaneModule) Attach(context interface{}, id tree.NodeID) error

func (*PaneModule) Current ¶

func (p *PaneModule) Current(context interface{}) *tree.NodeID

type PathModule ¶

type PathModule struct{}

func (*PathModule) Abs ¶

func (p *PathModule) Abs(path string) (string, error)

func (*PathModule) Base ¶

func (p *PathModule) Base(path string) string

func (*PathModule) Join ¶

func (p *PathModule) Join(elem []string) string

type ReplayModule ¶ added in v0.1.5

type ReplayModule struct {
}

func (*ReplayModule) Beginning ¶ added in v0.1.5

func (m *ReplayModule) Beginning(context interface{}) error

func (*ReplayModule) Copy ¶ added in v0.1.5

func (m *ReplayModule) Copy(context interface{}) error

func (*ReplayModule) CursorDown ¶ added in v0.1.5

func (m *ReplayModule) CursorDown(context interface{}) error

func (*ReplayModule) CursorLeft ¶ added in v0.1.5

func (m *ReplayModule) CursorLeft(context interface{}) error

func (*ReplayModule) CursorRight ¶ added in v0.1.5

func (m *ReplayModule) CursorRight(context interface{}) error

func (*ReplayModule) CursorUp ¶ added in v0.1.5

func (m *ReplayModule) CursorUp(context interface{}) error

func (*ReplayModule) End ¶ added in v0.1.5

func (m *ReplayModule) End(context interface{}) error

func (*ReplayModule) HalfPageDown ¶ added in v0.1.5

func (m *ReplayModule) HalfPageDown(context interface{}) error

func (*ReplayModule) HalfPageUp ¶ added in v0.1.5

func (m *ReplayModule) HalfPageUp(context interface{}) error

func (*ReplayModule) Quit ¶ added in v0.1.5

func (m *ReplayModule) Quit(context interface{}) error

func (*ReplayModule) ScrollDown ¶ added in v0.1.5

func (m *ReplayModule) ScrollDown(context interface{}) error

func (*ReplayModule) ScrollUp ¶ added in v0.1.5

func (m *ReplayModule) ScrollUp(context interface{}) error

func (*ReplayModule) SearchAgain ¶ added in v0.1.5

func (m *ReplayModule) SearchAgain(context interface{}) error

func (*ReplayModule) SearchBackward ¶ added in v0.1.5

func (m *ReplayModule) SearchBackward(context interface{}) error

func (*ReplayModule) SearchForward ¶ added in v0.1.5

func (m *ReplayModule) SearchForward(context interface{}) error

func (*ReplayModule) SearchReverse ¶ added in v0.1.5

func (m *ReplayModule) SearchReverse(context interface{}) error

func (*ReplayModule) Select ¶ added in v0.1.5

func (m *ReplayModule) Select(context interface{}) error

func (*ReplayModule) TimePlay ¶ added in v0.1.5

func (m *ReplayModule) TimePlay(context interface{}) error

func (*ReplayModule) TimePlaybackRate ¶ added in v0.1.5

func (m *ReplayModule) TimePlaybackRate(context interface{}, rate int) error

func (*ReplayModule) TimeStepBack ¶ added in v0.1.5

func (m *ReplayModule) TimeStepBack(context interface{}) error

func (*ReplayModule) TimeStepForward ¶ added in v0.1.5

func (m *ReplayModule) TimeStepForward(context interface{}) error

type TreeModule ¶

type TreeModule struct {
	Tree *tree.Tree
}

func (*TreeModule) Group ¶

func (t *TreeModule) Group(id tree.NodeID) bool

func (*TreeModule) Kill ¶ added in v0.1.1

func (t *TreeModule) Kill(id tree.NodeID) error

func (*TreeModule) Name ¶

func (t *TreeModule) Name(id tree.NodeID) *string

func (*TreeModule) Pane ¶

func (t *TreeModule) Pane(id tree.NodeID) bool

func (*TreeModule) Parent ¶

func (t *TreeModule) Parent(id tree.NodeID) *tree.NodeID

func (*TreeModule) Renames ¶

func (t *TreeModule) Renames() map[string]string

func (*TreeModule) Root ¶

func (t *TreeModule) Root() tree.NodeID

func (*TreeModule) SetName ¶

func (t *TreeModule) SetName(id tree.NodeID, name string)

Source Files ¶

View all Source files

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