tree

Documentation

Index

• type Group
  • func (m Group) Binds() *bind.BindScope
  • func (g *Group) ChildByName(name string) (node Node, ok bool)
  • func (g *Group) Children() []Node
  • func (m Group) Id() int32
  • func (g *Group) Leaves() []Node
  • func (m Group) Name() string
  • func (g *Group) NewGroup() *Group
  • func (g *Group) NewPane(ctx context.Context, screen mux.Screen) *Pane
  • func (g *Group) NewPaneCreator(ctx context.Context) (NodeID, func(screen mux.Screen) *Pane)
  • func (m Group) Params() *params.Parameters
  • func (m Group) Protected() bool
  • func (m Group) SetName(name string)
  • func (m Group) SetProtected(value bool)
• type Node
• type NodeEvent
• type NodeID
• type Pane
  • func (m Pane) Binds() *bind.BindScope
  • func (m Pane) Id() int32
  • func (m Pane) Name() string
  • func (m Pane) Params() *params.Parameters
  • func (m Pane) Protected() bool
  • func (p *Pane) Screen() mux.Screen
  • func (m Pane) SetName(name string)
  • func (m Pane) SetProtected(value bool)
• type Tree
  • func NewTree(options ...TreeOption) *Tree
  • func (t *Tree) GroupById(id NodeID) (*Group, bool)
  • func (t *Tree) Leaves() []Node
  • func (t *Tree) NodeById(id NodeID) (Node, bool)
  • func (t *Tree) PaneById(id NodeID) (*Pane, bool)
  • func (t *Tree) PathTo(node Node) []Node
  • func (t *Tree) RemoveNode(id NodeID) error
  • func (t *Tree) Reset()
  • func (t *Tree) Root() *Group
• type TreeOption
  • func WithParams(p *params.Parameters) TreeOption

Types

type Group

type Group struct {
	deadlock.RWMutex
	// contains filtered or unexported fields
}

func (Group) Binds

func (m Group) Binds() *bind.BindScope

func (*Group) ChildByName

func (g *Group) ChildByName(name string) (node Node, ok bool)

func (*Group) Children

func (g *Group) Children() []Node

func (Group) Id

func (m Group) Id() int32

func (*Group) Leaves

func (g *Group) Leaves() []Node

func (Group) Name

func (m Group) Name() string

func (*Group) NewGroup

func (g *Group) NewGroup() *Group

func (*Group) NewPane

func (g *Group) NewPane(ctx context.Context, screen mux.Screen) *Pane

func (*Group) NewPaneCreator

func (g *Group) NewPaneCreator(ctx context.Context) (NodeID, func(screen mux.Screen) *Pane)

NewPaneCreator is the same as NewPane, but it gives you the NodeID before the Node is created and a function to call with the final Screen.

func (Group) Params

func (m Group) Params() *params.Parameters

func (Group) Protected

func (m Group) Protected() bool

Protected reports whether or not this node is protected (or cannot be removed.)

func (Group) SetName

func (m Group) SetName(name string)

func (Group) SetProtected

func (m Group) SetProtected(value bool)

SetProtected sets whether or not this node can be removed.

type Node

type Node interface {
	Id() NodeID
	Name() string
	Params() *params.Parameters
	SetName(string)
	Protected() bool
	Binds() *bind.BindScope
}

type NodeEvent

type NodeEvent struct {
	Id    NodeID
	Event events.Msg
}

type NodeID

type NodeID = int32

type Pane

type Pane struct {
	util.Lifetime
	// contains filtered or unexported fields
}

func (Pane) Binds

func (m Pane) Binds() *bind.BindScope

func (Pane) Id

func (m Pane) Id() int32

func (Pane) Name

func (m Pane) Name() string

func (Pane) Params

func (m Pane) Params() *params.Parameters

func (Pane) Protected

func (m Pane) Protected() bool

Protected reports whether or not this node is protected (or cannot be removed.)

func (*Pane) Screen

func (p *Pane) Screen() mux.Screen

func (Pane) SetName

func (m Pane) SetName(name string)

func (Pane) SetProtected

func (m Pane) SetProtected(value bool)

SetProtected sets whether or not this node can be removed.

type Tree

type Tree struct {
	deadlock.RWMutex
	*mux.UpdatePublisher
	// contains filtered or unexported fields
}

func NewTree

func NewTree(options ...TreeOption) *Tree

func (*Tree) GroupById

func (t *Tree) GroupById(id NodeID) (*Group, bool)

func (*Tree) Leaves

func (t *Tree) Leaves() []Node

func (*Tree) NodeById

func (t *Tree) NodeById(id NodeID) (Node, bool)

func (*Tree) PaneById

func (t *Tree) PaneById(id NodeID) (*Pane, bool)

func (*Tree) PathTo

func (t *Tree) PathTo(node Node) []Node

Get the path from the root node to the given node.

func (*Tree) RemoveNode

func (t *Tree) RemoveNode(id NodeID) error

func (*Tree) Reset

func (t *Tree) Reset()

Reset safely clears the state of the tree. Only useful in testing.

func (*Tree) Root

func (t *Tree) Root() *Group

type TreeOption

type TreeOption func(*Tree)

func WithParams

func WithParams(p *params.Parameters) TreeOption