list

type ListSerializer ¶

type ListSerializer[T cmp.Ordered] interface {
	Serialize(writer io.Writer, vertices []*dag.Vertex[T]) error
}

ListSerializer is an interface that defines a method to create a serializable object from a vertex.

type ListSerializerFunc ¶

type ListSerializerFunc[T cmp.Ordered] func(writer io.Writer, vertices []*dag.Vertex[T]) error

ListSerializerFunc is a function type that implements the ListSerializer interface.

func (f ListSerializerFunc[T]) Serialize(writer io.Writer, vertices []*dag.Vertex[T]) error

type Renderer ¶

type Renderer[T cmp.Ordered] struct {
	// contains filtered or unexported fields
}

Renderer renders a tree from a DirectedAcyclicGraph as a flat last in a particular output format. The output rendered by the Renderer with OutputFormatJSON looks like this:

[
  "A",
  "B",
  "C",
  "D"
]

The output is analogous to a tree structure, but without the indentation.

── A
   ├─ B
   │  ╰─ C
   ╰─ D

Each letter corresponds to a vertex in the DirectedAcyclicGraph. The concrete representation of the vertex is defined by the ListSerializer.

func New[T cmp.Ordered](ctx context.Context, graph *syncdag.SyncedDirectedAcyclicGraph[T], opts ...RendererOption[T]) *Renderer[T]

func (r *Renderer[T]) Render(ctx context.Context, writer io.Writer) error

type RendererOption ¶

type RendererOption[T cmp.Ordered] func(*RendererOptions[T])

RendererOption is a function that modifies the RendererOptions.

func WithListSerializer[T cmp.Ordered](serializer ListSerializer[T]) RendererOption[T]

func WithListSerializerFunc[T cmp.Ordered](serializerFunc func(writer io.Writer, vertices []*dag.Vertex[T]) error) RendererOption[T]

func WithRoots[T cmp.Ordered](roots ...T) RendererOption[T]

type RendererOptions ¶

type RendererOptions[T cmp.Ordered] struct {
	// The ListSerializer converts a vertex to an object that is expected to
	// be a serializable type (e.g., a struct or map). The ListSerializer MUST
	// perform READ-ONLY access to the vertex and its attributes.
	ListSerializer ListSerializer[T]
	// Roots are the root vertices of the list to render.
	Roots []T
}

RendererOptions defines the options for the list Renderer.

type Serializer ¶

type Serializer[T cmp.Ordered] struct {
	// VertexSerializer is a function that converts a vertex to an object
	// that can be serialized to JSON.
	VertexSerializer VertexSerializer[T]
	// OutputFormat specifies the format in which the output should be rendered.
	// Serializer supports JSON, NDJSON, and YAML formats.
	OutputFormat render.OutputFormat
}

Serializer implements the ListSerializer interface for serializing a slice of vertices to a set of output formats.

func NewSerializer[T cmp.Ordered](opts ...SerializerOption[T]) Serializer[T]

func (s Serializer[T]) Serialize(writer io.Writer, vertices []*dag.Vertex[T]) error

type SerializerOption ¶

type SerializerOption[T cmp.Ordered] func(*Serializer[T])

SerializerOption is a function that modifies the SerializerOptions.

func WithOutputFormat[T cmp.Ordered](format render.OutputFormat) SerializerOption[T]

func WithVertexSerializer[T cmp.Ordered](serializer VertexSerializer[T]) SerializerOption[T]

func WithVertexSerializerFunc[T cmp.Ordered](serializerFunc func(vertex *dag.Vertex[T]) (any, error)) SerializerOption[T]

type VertexSerializer ¶

type VertexSerializer[T cmp.Ordered] interface {
	// Serialize converts a vertex to an object that can be serialized.
	Serialize(vertex *dag.Vertex[T]) (any, error)
}

type VertexSerializerFunc ¶

type VertexSerializerFunc[T cmp.Ordered] func(vertex *dag.Vertex[T]) (any, error)

VertexSerializerFunc is a function type that implements the VertexSerializer interface.

func (f VertexSerializerFunc[T]) Serialize(vertex *dag.Vertex[T]) (any, error)