Documentation
¶
Overview ¶
Package path contains types that represent data references.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func HasRoot ¶ added in v0.6.1
HasRoot returns true iff p starts with root, using equal as the node comparision function.
func ShallowEqual ¶ added in v0.6.1
ShallowEqual returns true if paths a and b are equal (ignoring parents).
Types ¶
type Linker ¶
type Linker interface {
// Link returns the link to the pointee of this object at p.
// If nil, nil is returned then the path cannot be followed.
Link(ctx context.Context, p Node, r *ResolveConfig) (Node, error)
}
Linker is the interface implemented by types that can point to other objects.
type Node ¶
type Node interface {
// Parent returns the path that this path derives from.
// If this path is a root, then Base returns nil.
Parent() Node
// SetParent sets the path that this derives from.
SetParent(Node)
// Path returns this path node as a path.
Path() *Any
// Validate checks the path for correctness, returning an error if any
// issues are found.
Validate() error
}
Node is the interface for types that represent a reference to a capture, command list, single command, memory, state or sub-object. A path can be passed between client and server using RPCs in order to describe some data in a capture.
Source Files
Click to show internal directories.
Click to hide internal directories.