projecttype

Documentation

Overview

Package projecttype defines the Arduino project types.

Index

• type Type
  • func FromString(projectTypeString string) (Type, error)
  • func (projectTypeA Type) Matches(projectTypeB Type) bool
  • func (i Type) String() string

Types

type Type

type Type int

Type is the type for Arduino project types.

const (
	// Sketch is used for Arduino sketch projects.
	Sketch Type = iota // sketch
	// Library is used for Arduino library projects.
	Library // library
	// Platform is used for Arduino boards platform projects.
	Platform // platform
	// PackageIndex is used for Arduino package index projects.
	PackageIndex // package-index
	// All is the catch-all for all supported Arduino project types.
	All // all
	// Not is the project type used when an Arduino project was not detected.
	Not // N/A
)

func FromString

func FromString(projectTypeString string) (Type, error)

FromString parses the --project-type flag value and returns the corresponding project type.

func (Type) Matches

func (projectTypeA Type) Matches(projectTypeB Type) bool

Matches returns whether the receiver project type matches the argument project type.

func (Type) String

func (i Type) String() string