platform

Documentation

Index

• type CompoundGrapher
  • func (g *CompoundGrapher) Graph(ctx context.Context) (Graph, error)
• type ContinousGrapher
• type Graph
  • func NewGraph() Graph
• type Grapher
• type ImageNode
  • func (n ImageNode) ID() string
  • func (n ImageNode) String() string
  • func (n ImageNode) Type() string
• type Node
• type PollGrapher
  • func (g *PollGrapher) GraphContinously(ctx context.Context) (<-chan Graph, error)

Types

type CompoundGrapher

type CompoundGrapher struct {
	Graphers []Grapher
}

CompoundGrapher creates a graph from one or more Grapher simultaneously.

func (*CompoundGrapher) Graph

func (g *CompoundGrapher) Graph(ctx context.Context) (Graph, error)

type ContinousGrapher

type ContinousGrapher interface {
	// GraphContinously returns a channel which will receive a graph of all
	// images found on the platform whenever the graph changes.
	// The graph's roots are [ImageNode]s.
	GraphContinously(context.Context) (<-chan Graph, error)
}

type Graph

type Graph = *graph.Graph[Node]

func NewGraph

func NewGraph() Graph

type Grapher

type Grapher interface {
	// Graph returns a graph of all images found on the platform.
	// The graph's roots are [ImageNode]s.
	Graph(context.Context) (Graph, error)
}

type ImageNode

type ImageNode struct {
	Reference oci.Reference
}

func (ImageNode) ID

func (n ImageNode) ID() string

func (ImageNode) String

func (n ImageNode) String() string

func (ImageNode) Type

func (n ImageNode) Type() string

type Node

type Node interface {
	ID() string
	Type() string
}

type PollGrapher

type PollGrapher struct {
	Grapher  Grapher
	Interval time.Duration
}

func (*PollGrapher) GraphContinously

func (g *PollGrapher) GraphContinously(ctx context.Context) (<-chan Graph, error)