bricksindex

package
v0.6.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 27, 2025 License: GPL-3.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Brick

type Brick struct {
	ID                        string          `yaml:"id"`
	Name                      string          `yaml:"name"`
	Description               string          `yaml:"description"`
	Category                  string          `yaml:"category,omitempty"`
	RequiresDisplay           string          `yaml:"requires_display,omitempty"`
	RequireContainer          bool            `yaml:"require_container"`
	RequireModel              bool            `yaml:"require_model"`
	Variables                 []BrickVariable `yaml:"variables,omitempty"`
	Ports                     []string        `yaml:"ports,omitempty"`
	ModelName                 string          `yaml:"model_name,omitempty"`
	MountDevicesIntoContainer bool            `yaml:"mount_devices_into_container,omitempty"`
	RequiredDevices           []string        `yaml:"required_devices,omitempty"`
}

func (Brick) GetDefaultVariables

func (b Brick) GetDefaultVariables() iter.Seq2[string, string]

func (Brick) GetVariable

func (b Brick) GetVariable(name string) (BrickVariable, bool)

type BrickVariable

type BrickVariable struct {
	Name         string `yaml:"name"`
	DefaultValue string `yaml:"default_value"`
	Description  string `yaml:"description,omitempty"`
}

func (BrickVariable) IsRequired

func (v BrickVariable) IsRequired() bool

type BricksIndex

type BricksIndex struct {
	Bricks []Brick `yaml:"bricks"`
}

func GenerateBricksIndexFromFile

func GenerateBricksIndexFromFile(dir *paths.Path) (*BricksIndex, error)

func (*BricksIndex) FindBrickByID

func (b *BricksIndex) FindBrickByID(id string) (*Brick, bool)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL