package dot

Import Path
	go.uber.org/dig/internal/dot (on go.dev)

Dependency Relation
	imports 2 packages, and imported by one package

Involved Source Files

	    graph.go
Package-Level Type Names (total 9)

	/* sort by: alphabet | popularity */
	 type Ctor (struct)
		Ctor encodes a constructor provided to the container for the DOT graph.

		Fields (total 9)
			ErrorType ErrorType
			File string
			GroupParams []*Group
			ID CtorID
			Line int
			Name string
			Package string
			Params []*Param
			Results []*Result
		As Inputs Of (at least one exported)
			func (*Graph).AddCtor(c *Ctor, paramList []*Param, resultList []*Result)

	 type CtorID uintptr (basic type)
		CtorID is a unique numeric identifier for constructors.

		As Inputs Of (at least 2)
			func (*Graph).FailGroupNodes(name string, t reflect.Type, id CtorID)
			func (*Graph).FailNodes(results []*Result, id CtorID)

	 type ErrorType int (basic type)
		ErrorType of a constructor or group is updated when they fail to build.

		Methods (only one)
			( ErrorType) Color() string
				Color returns the color representation of each ErrorType.


	 type FailedNodes (struct)
		FailedNodes is the nodes that failed in the graph.

		Fields (total 2)
			RootCauses []*Result
				RootCauses is a list of the point of failures. They are the root causes
				of failed invokes and can be either missing types (not provided) or
				error types (error providing).

			TransitiveFailures []*Result
				TransitiveFailures is the list of nodes that failed to build due to
				missing/failed dependencies.


	 type Graph (struct)
		Graph is the DOT-format graph in a Container.

		Fields (total 3)
			Ctors []*Ctor
			Failed *FailedNodes
			Groups []*Group
		Methods (total 5)
			(*Graph) AddCtor(c *Ctor, paramList []*Param, resultList []*Result)
				AddCtor adds the constructor with paramList and resultList into the graph.

			(*Graph) AddMissingNodes(results []*Result)
				AddMissingNodes adds missing nodes to the list of failed Results in the graph.

			(*Graph) FailGroupNodes(name string, t reflect.Type, id CtorID)
				FailGroupNodes finds and adds the failed grouped nodes to the list of failed
				Results in the graph, and updates the state of the group and constructor
				with the given id accordingly.

			(*Graph) FailNodes(results []*Result, id CtorID)
				FailNodes adds results to the list of failed Results in the graph, and
				updates the state of the constructor with the given id accordingly.

			(*Graph) PruneSuccess()
				PruneSuccess removes elements from the graph that do not have failed results.
				Removing elements that do not have failing results makes the graph easier to debug,
				since non-failing nodes and edges can clutter the graph and don't help the user debug.

		As Outputs Of (at least one exported)
			func NewGraph() *Graph

	 type Group (struct)
		Group is a group node in the graph. Group represents an fx value group.

		Fields (total 4)
			ErrorType ErrorType
			Name string
			Results []*Result
			Type reflect.Type
				Type is the type of values in the group.

		Methods (total 2)
			(*Group) Attributes() string
				Attributes composes and returns a string of the Group node's attributes.

			(*Group) String() string
				String implements fmt.Stringer for Group.

		Implements (at least 2)
			*Group : expvar.Var
			*Group : fmt.Stringer
		As Outputs Of (at least one exported)
			func NewGroup(k nodeKey) *Group

	 type Node (struct)
		Node is a single node in a graph and is embedded into Params and Results.

		Fields (total 3)
			Group string
			Name string
			Type reflect.Type

	 type Param (struct)
		Param is a parameter node in the graph. Parameters are the input to constructors.

		Fields (total 5)
			Node *Node
			Node.Group string
			Node.Name string
			Node.Type reflect.Type
			Optional bool
		Methods (only one)
			(*Param) String() string
				String implements fmt.Stringer for Param.

		Implements (at least 2)
			*Param : expvar.Var
			*Param : fmt.Stringer
		As Inputs Of (at least one exported)
			func (*Graph).AddCtor(c *Ctor, paramList []*Param, resultList []*Result)

	 type Result (struct)
		Result is a result node in the graph. Results are the output of constructors.

		Fields (total 5)
			GroupIndex int
				GroupIndex is added to differentiate grouped values from one another.
				Since grouped values have the same type and group, their Node / string
				representations are the same so we need indices to uniquely identify
				the values.

			Node *Node
			Node.Group string
			Node.Name string
			Node.Type reflect.Type
		Methods (total 2)
			(*Result) Attributes() string
				Attributes composes and returns a string of the Result node's attributes.

			(*Result) String() string
				String implements fmt.Stringer for Result.

		Implements (at least 2)
			*Result : expvar.Var
			*Result : fmt.Stringer
		As Inputs Of (at least 3)
			func (*Graph).AddCtor(c *Ctor, paramList []*Param, resultList []*Result)
			func (*Graph).AddMissingNodes(results []*Result)
			func (*Graph).FailNodes(results []*Result, id CtorID)


Package-Level Functions (total 2)

	 func NewGraph() *Graph
		NewGraph creates an empty graph.

	 func NewGroup(k nodeKey) *Group
		NewGroup creates a new group with information in the groupKey.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.