srtructurizr

Documentation

Index

• func SafeID(v string) (id string)
• type Component
  • func (c *Component) Write(w io.Writer, level int)
• type Container
  • func (c *Container) Write(w io.Writer, level int)
• type Relation
• type System
  • func NewSystem(name string) *System
  • func (s *System) AddContainer(id, name string) (c *Container, ok bool)
  • func (s *System) AddRelation(srcID, dstID, srcName, dstName string) (rv *Relation, ok bool)
  • func (s *System) WriteContainers(w io.Writer, level int)
  • func (s *System) WriteRelations(w io.Writer, level int)
  • func (s *System) WriteViews(w io.Writer, level int)
• type Workspace
  • func NewWorkspace(name, defaultSystem string) *Workspace
  • func (ws *Workspace) AddRelation(srcID, dstID, srcName, dstName string) (rv *Relation, ok bool)
  • func (ws *Workspace) HasSystem(name string) (yes bool)
  • func (ws *Workspace) System(name string) (rv *System)
  • func (ws *Workspace) Write(w io.Writer)

Functions

func SafeID

func SafeID(v string) (id string)

Types

type Component

type Component struct {
	ID          string
	Name        string
	Description string
	Technology  string
	Tags        []string
}

func (*Component) Write

func (c *Component) Write(w io.Writer, level int)

type Container

type Container struct {
	ID          string
	Name        string
	Description string
	Technology  string
	Tags        []string
	Components  []*Component
}

func (*Container) Write

func (c *Container) Write(w io.Writer, level int)

type Relation

type Relation struct {
	Src  string
	Dst  string
	Tags []string
}

type System

type System struct {
	ID          string
	Name        string
	Description string
	Tags        []string
	// contains filtered or unexported fields
}

func NewSystem

func NewSystem(name string) *System

func (*System) AddContainer

func (s *System) AddContainer(id, name string) (c *Container, ok bool)

func (*System) AddRelation

func (s *System) AddRelation(srcID, dstID, srcName, dstName string) (rv *Relation, ok bool)

func (*System) WriteContainers

func (s *System) WriteContainers(w io.Writer, level int)

func (*System) WriteRelations

func (s *System) WriteRelations(w io.Writer, level int)

func (*System) WriteViews

func (s *System) WriteViews(w io.Writer, level int)

type Workspace

type Workspace struct {
	Name        string
	Description string
	// contains filtered or unexported fields
}

func NewWorkspace

func NewWorkspace(name, defaultSystem string) *Workspace

func (*Workspace) AddRelation

func (ws *Workspace) AddRelation(srcID, dstID, srcName, dstName string) (rv *Relation, ok bool)

func (*Workspace) HasSystem

func (ws *Workspace) HasSystem(name string) (yes bool)

func (*Workspace) System

func (ws *Workspace) System(name string) (rv *System)

func (*Workspace) Write

func (ws *Workspace) Write(w io.Writer)