types

Documentation

Overview

Package types provides shared types used by multiple packages in the "bruh" application.

Index

• type BicepDirectory
  • func (dir BicepDirectory) String() string
• type BicepFile
  • func (file BicepFile) String() string
• type Mode
  • func (s Mode) String() string
• type Resource
  • func (r Resource) String() string

Types

type BicepDirectory

type BicepDirectory struct {
	Name  string
	Files []BicepFile
}

BicepDirectory contains information about a bicep directory:

• Name: the name of the bicep directory (e.g. virtualNetworks)
• Files: the bicep files in the bicep directory

func (BicepDirectory) String

func (dir BicepDirectory) String() string

String returns a string representation of a types.BicepDirectory object.

type BicepFile

type BicepFile struct {
	Name      string
	Resources []Resource
}

BicepFile contains information about a bicep file:

• Name: the name of the bicep file (e.g. virtualNetworks.bicep)
• Resources: the bicep resources defined in the bicep file

func (BicepFile) String

func (file BicepFile) String() string

String returns a string representation of a types.BicepFile object.

type Mode

type Mode int8

Mode represents the mode of the cli (scan or update).

const (
	ModeScan   Mode = iota // ModeScan corresponds to the `bruh scan` command
	ModeUpdate             // ModeUpdate corresponds to the `bruh update` command
)

func (Mode) String

func (s Mode) String() string

String returns a string representation of a types.Mode object.

type Resource

type Resource struct {
	ID                   string
	Name                 string
	Namespace            string
	CurrentAPIVersion    string
	AvailableAPIVersions []string
}

Resource contains information about a resource:

• ID: the resource ID (e.g. Microsoft.Network/virtualNetworks)
• Name: the resource name (e.g. virtualNetworks)
• Namespace: the resource namespace (e.g. Microsoft.Network)
• CurrentAPIVersion: the used API version (e.g. 2021-02-01)
• AvailableAPIVersions: the available API versions (e.g. [2021-02-01 2020-11-01])

func (Resource) String

func (r Resource) String() string

String returns a string representation of a types.Resource object.