node

package

v0.0.0-...-02c76fb Latest Latest Go to latest Published: Nov 10, 2020 License: Apache-2.0 Imports: 3 Imported by: 12

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

This section is empty.

View Source

var ErrMetadataNotUnique = errors.New("metadata field is non-unique")

ErrMetadataNotUnique indicates that the user attempted to overwrite a node metadata field.

This section is empty.

type Groupable interface {
	Group() string
}

Groupable returns a group

type Node struct {
	ID    string `json:"id"`
	Group string `json:"group"`
	// contains filtered or unexported fields
}

Node tracks the metadata associated with a node in the graph

func New(id string, value interface{}) *Node

New creates a new node

func (n *Node) AddMetadata(key string, value interface{}) error

AddMetadata will allow you to add metadata to the node. If the key already exists it will return ErrMetadataNotUnique to ensure immutability

func (n *Node) LookupMetadata(key string) (interface{}, bool)

LookupMetadata extracts a metdatadata field from the node. If the value is found, it returns (value, true), and (nil, false) otherwise.

func (n *Node) ShowMetadata() string

ShowMetadata will print out the existing metadata. Used for debugging

func (n *Node) Value() interface{}

Value gets the inner value of this node

func (n *Node) WithValue(value interface{}) *Node

WithValue returns a copy of the node with the new value set

Path	Synopsis
conditional