dot

package

v0.0.0-...-79d4ce4 Latest Latest Go to latest Published: Jan 24, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

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.

This section is empty.

func Marshal(g graph.Graph) []byte

Marshal returns the DOT encoding for the graph g

func Unmarshal(b []byte) *simple.DirectedGraph

Unmarshal reads a slice of bytes containing a dot encoded graph and returns a *simple.DirectedGraph with edges and nodes containing attributes

type Graph struct {
	*simple.DirectedGraph
}

Graph ensures dotEdge and Node types are created when needed.

func (g Graph) GetNodeByDOTID(DOTID string) graph.Node

GetNodeByDOTID gets a Node by it's DOT ID.

func (g Graph) NewEdge(from, to graph.Node) graph.Edge

NewNode returns a new Edge to be added to g. The Edge contains the attributes.

func (g Graph) NewNode() graph.Node

NewNode returns a new Node to be added to g. The Node contains the attributes.

type Node struct {
	graph.Node
	// contains filtered or unexported fields
}

Node handles basic DOT serialisation and deserialisation

func (n *Node) Attribute(key string) (string, error)

Attribute gets a DOT attribute.

func (n *Node) Attributes() []encoding.Attribute

Attributes gets the slice of attributes defined for the node.

func (n *Node) DOTID() string

DOTID gets the DOT attribute.

func (n *Node) SetAttribute(attr encoding.Attribute) error

SetAttribute sets a DOT attribute.

func (n *Node) SetDOTID(id string)

SetDOTID sets the DOT ID.