result
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Index¶
- type Board
- type BoardDetailsResponse
- type BoardIdentificationProperties
- type BoardListAllResponse
- type BoardListItem
- type BoardListWatchResponse
- type BoardPlatform
- type BuilderResult
- type CompileDiagnostic
- type CompileDiagnosticContext
- type CompileDiagnosticNote
- type ConfigOption
- type ConfigValue
- type DetectedPort
- type DownloadResource
- type ExecutableSectionSize
- type Help
- type HelpResource
- type IndexUpdateReportResult
- type IndexUpdateReport_Status
- type InstalledLibrary
- type InstalledPlatformReference
- type IsDebugSupportedResponse
- type Library
- type LibraryDependency
- type LibraryDependencyStatus
- type LibraryLayout
- type LibraryLocation
- type LibraryRelease
- type LibraryResolveDependenciesResponse
- type LibrarySearchResponse
- type LibrarySearchStatus
- type MonitorPortSettingDescriptor
- type Package
- type Platform
- type PlatformMetadata
- type PlatformRelease
- type PlatformSummary
- type Port
- type Programmer
- type SearchedLibrary
- type System
- type ToolsDependency
- type UpdateIndexResponse_ResultResult
- type UpdateLibrariesIndexResponse_ResultResult
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeBoardDetailsResponse¶
type BoardDetailsResponse struct {Fqbnstring `json:"fqbn,omitempty"`Namestring `json:"name,omitempty"`Versionstring `json:"version,omitempty"`PropertiesIdstring `json:"properties_id,omitempty"`Aliasstring `json:"alias,omitempty"`Officialbool `json:"official,omitempty"`Pinoutstring `json:"pinout,omitempty"`Package *Package `json:"package,omitempty"`Platform *BoardPlatform `json:"platform,omitempty"`ToolsDependencies []*ToolsDependency `json:"tools_dependencies,omitempty"`ConfigOptions []*ConfigOption `json:"config_options,omitempty"`Programmers []*Programmer `json:"programmers,omitempty"`IdentificationProperties []*BoardIdentificationProperties `json:"identification_properties,omitempty"`BuildProperties []string `json:"build_properties,omitempty"`DefaultProgrammerIDstring `json:"default_programmer_id,omitempty"`}funcNewBoardDetailsResponse¶
func NewBoardDetailsResponse(b *rpc.BoardDetailsResponse) *BoardDetailsResponse
typeBoardIdentificationProperties¶
type BoardIdentificationProperties struct {Propertiesorderedmap.Map[string,string] `json:"properties,omitempty"`}funcNewBoardIdentificationProperties¶
func NewBoardIdentificationProperties(p []*rpc.BoardIdentificationProperties) []*BoardIdentificationProperties
funcNewBoardIndentificationProperty¶
func NewBoardIndentificationProperty(p *rpc.BoardIdentificationProperties) *BoardIdentificationProperties
typeBoardListAllResponse¶
type BoardListAllResponse struct {Boards []*BoardListItem `json:"boards,omitempty"`}funcNewBoardListAllResponse¶
func NewBoardListAllResponse(p *rpc.BoardListAllResponse) *BoardListAllResponse
typeBoardListItem¶
type BoardListItem struct {Namestring `json:"name,omitempty"`Fqbnstring `json:"fqbn,omitempty"`IsHiddenbool `json:"is_hidden,omitempty"`Platform *Platform `json:"platform,omitempty"`}funcNewBoardListItem¶
func NewBoardListItem(b *rpc.BoardListItem) *BoardListItem
funcNewBoardListItems¶
func NewBoardListItems(b []*rpc.BoardListItem) []*BoardListItem
typeBoardListWatchResponse¶
type BoardListWatchResponse struct {EventTypestring `json:"event_type,omitempty"`Port *DetectedPort `json:"port,omitempty"`Errorstring `json:"error,omitempty"`}funcNewBoardListWatchResponse¶
func NewBoardListWatchResponse(r *rpc.BoardListWatchResponse) *BoardListWatchResponse
typeBoardPlatform¶
type BoardPlatform struct {Architecturestring `json:"architecture,omitempty"`Categorystring `json:"category,omitempty"`Urlstring `json:"url,omitempty"`ArchiveFilenamestring `json:"archive_filename,omitempty"`Checksumstring `json:"checksum,omitempty"`Sizeint64 `json:"size,omitempty"`Namestring `json:"name,omitempty"`}funcNewBoardPlatform¶
func NewBoardPlatform(p *rpc.BoardPlatform) *BoardPlatform
typeBuilderResult¶
type BuilderResult struct {BuildPathstring `json:"build_path,omitempty"`UsedLibraries []*Library `json:"used_libraries,omitempty"`ExecutableSectionsSize []*ExecutableSectionSize `json:"executable_sections_size,omitempty"`BoardPlatform *InstalledPlatformReference `json:"board_platform,omitempty"`BuildPlatform *InstalledPlatformReference `json:"build_platform,omitempty"`BuildProperties []string `json:"build_properties,omitempty"`Diagnostics []*CompileDiagnostic `json:"diagnostics,omitempty"`}funcNewBuilderResult¶
func NewBuilderResult(c *rpc.BuilderResult) *BuilderResult
typeCompileDiagnostic¶
type CompileDiagnostic struct {Severitystring `json:"severity,omitempty"`Messagestring `json:"message,omitempty"`Filestring `json:"file,omitempty"`Lineint64 `json:"line,omitempty"`Columnint64 `json:"column,omitempty"`Context []*CompileDiagnosticContext `json:"context,omitempty"`Notes []*CompileDiagnosticNote `json:"notes,omitempty"`}funcNewCompileDiagnostic¶
func NewCompileDiagnostic(cd *rpc.CompileDiagnostic) *CompileDiagnostic
funcNewCompileDiagnostics¶
func NewCompileDiagnostics(cd []*rpc.CompileDiagnostic) []*CompileDiagnostic
typeCompileDiagnosticContext¶
type CompileDiagnosticContext struct {Messagestring `json:"message,omitempty"`Filestring `json:"file,omitempty"`Lineint64 `json:"line,omitempty"`Columnint64 `json:"column,omitempty"`}funcNewCompileDiagnosticContext¶
func NewCompileDiagnosticContext(cdc *rpc.CompileDiagnosticContext) *CompileDiagnosticContext
typeCompileDiagnosticNote¶
type CompileDiagnosticNote struct {Messagestring `json:"message,omitempty"`Filestring `json:"file,omitempty"`Lineint64 `json:"line,omitempty"`Columnint64 `json:"column,omitempty"`}funcNewCompileDiagnosticNote¶
func NewCompileDiagnosticNote(cdn *rpc.CompileDiagnosticNote) *CompileDiagnosticNote
typeConfigOption¶
type ConfigOption struct {Optionstring `json:"option,omitempty"`OptionLabelstring `json:"option_label,omitempty"`Values []*ConfigValue `json:"values,omitempty"`}funcNewConfigOption¶
func NewConfigOption(o *rpc.ConfigOption) *ConfigOption
funcNewConfigOptions¶
func NewConfigOptions(c []*rpc.ConfigOption) []*ConfigOption
typeConfigValue¶
type ConfigValue struct {Valuestring `json:"value,omitempty"`ValueLabelstring `json:"value_label,omitempty"`Selectedbool `json:"selected,omitempty"`}funcNewConfigValue¶
func NewConfigValue(c *rpc.ConfigValue) *ConfigValue
funcNewConfigValues¶
func NewConfigValues(c []*rpc.ConfigValue) []*ConfigValue
typeDetectedPort¶
type DetectedPort struct {MatchingBoards []*BoardListItem `json:"matching_boards,omitempty"`Port *Port `json:"port,omitempty"`}funcNewDetectedPort¶
func NewDetectedPort(p *rpc.DetectedPort) *DetectedPort
funcNewDetectedPorts¶
func NewDetectedPorts(p []*rpc.DetectedPort) []*DetectedPort
typeDownloadResource¶
type DownloadResource struct {Urlstring `json:"url,omitempty"`ArchiveFilenamestring `json:"archive_filename,omitempty"`Checksumstring `json:"checksum,omitempty"`Sizeint64 `json:"size,omitempty"`CachePathstring `json:"cache_path,omitempty"`}funcNewDownloadResource¶
func NewDownloadResource(r *rpc.DownloadResource) *DownloadResource
typeExecutableSectionSize¶
type ExecutableSectionSize struct {Namestring `json:"name,omitempty"`Sizeint64 `json:"size,omitempty"`MaxSizeint64 `json:"max_size,omitempty"`}funcNewExecutableSectionSize¶
func NewExecutableSectionSize(s *rpc.ExecutableSectionSize) *ExecutableSectionSize
typeHelpResource¶
type HelpResource struct {Onlinestring `json:"online,omitempty"`}HelpResource maps a rpc.HelpResource
typeIndexUpdateReportResult¶
type IndexUpdateReportResult struct {IndexURLstring `json:"index_url"`StatusIndexUpdateReport_Status `json:"status"`}funcNewIndexUpdateReportResult¶
func NewIndexUpdateReportResult(resp *rpc.IndexUpdateReport) *IndexUpdateReportResult
typeIndexUpdateReport_Status¶
type IndexUpdateReport_Statusstring
const (IndexUpdateReport_StatusUnspecifiedIndexUpdateReport_Status = "unspecified"IndexUpdateReport_StatusAlreadyUpToDateIndexUpdateReport_Status = "already-up-to-date"IndexUpdateReport_StatusFailedIndexUpdateReport_Status = "failed"IndexUpdateReport_StatusSkippedIndexUpdateReport_Status = "skipped"IndexUpdateReport_StatusUpdatedIndexUpdateReport_Status = "updated")
funcNewIndexUpdateReport_Status¶
func NewIndexUpdateReport_Status(rrpc.IndexUpdateReport_Status)IndexUpdateReport_Status
typeInstalledLibrary¶
type InstalledLibrary struct {Library *Library `json:"library,omitempty"`Release *LibraryRelease `json:"release,omitempty"`}funcNewInstalledLibrary¶
func NewInstalledLibrary(l *rpc.InstalledLibrary) *InstalledLibrary
typeInstalledPlatformReference¶
type InstalledPlatformReference struct {Idstring `json:"id,omitempty"`Versionstring `json:"version,omitempty"`InstallDirstring `json:"install_dir,omitempty"`PackageUrlstring `json:"package_url,omitempty"`}funcNewInstalledPlatformReference¶
func NewInstalledPlatformReference(r *rpc.InstalledPlatformReference) *InstalledPlatformReference
typeIsDebugSupportedResponse¶
type IsDebugSupportedResponse struct {DebuggingSupportedbool `json:"debugging_supported"`DebugFQBNstring `json:"debug_fqbn,omitempty"`}funcNewIsDebugSupportedResponse¶
func NewIsDebugSupportedResponse(resp *rpc.IsDebugSupportedResponse) *IsDebugSupportedResponse
typeLibrary¶
type Library struct {Namestring `json:"name,omitempty"`Authorstring `json:"author,omitempty"`Maintainerstring `json:"maintainer,omitempty"`Sentencestring `json:"sentence,omitempty"`Paragraphstring `json:"paragraph,omitempty"`Websitestring `json:"website,omitempty"`Categorystring `json:"category,omitempty"`Architectures []string `json:"architectures,omitempty"`Types []string `json:"types,omitempty"`InstallDirstring `json:"install_dir,omitempty"`SourceDirstring `json:"source_dir,omitempty"`UtilityDirstring `json:"utility_dir,omitempty"`ContainerPlatformstring `json:"container_platform,omitempty"`DotALinkagebool `json:"dot_a_linkage,omitempty"`Precompiledbool `json:"precompiled,omitempty"`LdFlagsstring `json:"ld_flags,omitempty"`IsLegacybool `json:"is_legacy,omitempty"`Versionstring `json:"version,omitempty"`Licensestring `json:"license,omitempty"`Propertiesorderedmap.Map[string,string] `json:"properties,omitempty"`LocationLibraryLocation `json:"location,omitempty"`LayoutLibraryLayout `json:"layout,omitempty"`Examples []string `json:"examples,omitempty"`ProvidesIncludes []string `json:"provides_includes,omitempty"`CompatibleWithorderedmap.Map[string,bool] `json:"compatible_with,omitempty"`InDevelopmentbool `json:"in_development,omitempty"`}funcNewLibrary¶
typeLibraryDependency¶
type LibraryDependency struct {Namestring `json:"name,omitempty"`VersionConstraintstring `json:"version_constraint,omitempty"`}funcNewLibraryDependencies¶
func NewLibraryDependencies(d []*rpc.LibraryDependency) []*LibraryDependency
funcNewLibraryDependency¶
func NewLibraryDependency(d *rpc.LibraryDependency) *LibraryDependency
typeLibraryDependencyStatus¶
type LibraryDependencyStatus struct {Namestring `json:"name,omitempty"`VersionRequiredstring `json:"version_required,omitempty"`VersionInstalledstring `json:"version_installed,omitempty"`}funcNewLibraryDependencyStatus¶
func NewLibraryDependencyStatus(l *rpc.LibraryDependencyStatus) *LibraryDependencyStatus
typeLibraryLayout¶
type LibraryLayoutstring
const (LibraryLayoutFlatLibraryLayout = "flat"LibraryLayoutRecursiveLibraryLayout = "recursive")
funcNewLibraryLayout¶
func NewLibraryLayout(rrpc.LibraryLayout)LibraryLayout
typeLibraryLocation¶
type LibraryLocationstring
const (LibraryLocationUserLibraryLocation = "user"LibraryLocationIDEBuiltinLibraryLocation = "ide"LibraryLocationPlatformBuiltinLibraryLocation = "platform"LibraryLocationReferencedPlatformBuiltinLibraryLocation = "ref-platform"LibraryLocationUnmangedLibraryLocation = "unmanaged"LibraryLocationProfileLibraryLocation = "profile")
funcNewLibraryLocation¶
func NewLibraryLocation(rrpc.LibraryLocation)LibraryLocation
typeLibraryRelease¶
type LibraryRelease struct {Authorstring `json:"author,omitempty"`Versionstring `json:"version,omitempty"`Maintainerstring `json:"maintainer,omitempty"`Sentencestring `json:"sentence,omitempty"`Paragraphstring `json:"paragraph,omitempty"`Websitestring `json:"website,omitempty"`Categorystring `json:"category,omitempty"`Architectures []string `json:"architectures,omitempty"`Types []string `json:"types,omitempty"`Resources *DownloadResource `json:"resources,omitempty"`Licensestring `json:"license,omitempty"`ProvidesIncludes []string `json:"provides_includes,omitempty"`Dependencies []*LibraryDependency `json:"dependencies,omitempty"`}funcNewLibraryRelease¶
func NewLibraryRelease(l *rpc.LibraryRelease) *LibraryRelease
typeLibraryResolveDependenciesResponse¶
type LibraryResolveDependenciesResponse struct {Dependencies []*LibraryDependencyStatus `json:"dependencies,omitempty"`}funcNewLibraryResolveDependenciesResponse¶
func NewLibraryResolveDependenciesResponse(l *rpc.LibraryResolveDependenciesResponse) *LibraryResolveDependenciesResponse
typeLibrarySearchResponse¶
type LibrarySearchResponse struct {Libraries []*SearchedLibrary `json:"libraries,omitempty"`StatusLibrarySearchStatus `json:"status,omitempty"`}funcNewLibrarySearchResponse¶
func NewLibrarySearchResponse(l *rpc.LibrarySearchResponse) *LibrarySearchResponse
typeLibrarySearchStatus¶
type LibrarySearchStatusstring
const (LibrarySearchStatusFailedLibrarySearchStatus = "failed"LibrarySearchStatusSuccessLibrarySearchStatus = "success")
funcNewLibrarySearchStatus¶
func NewLibrarySearchStatus(rrpc.LibrarySearchStatus)LibrarySearchStatus
typeMonitorPortSettingDescriptor¶
type MonitorPortSettingDescriptor struct {SettingIdstring `json:"setting_id,omitempty"`Labelstring `json:"label,omitempty"`Typestring `json:"type,omitempty"`EnumValues []string `json:"enum_values,omitempty"`Valuestring `json:"value,omitempty"`}funcNewMonitorPortSettingDescriptor¶
func NewMonitorPortSettingDescriptor(m *rpc.MonitorPortSettingDescriptor) *MonitorPortSettingDescriptor
typePackage¶
type Package struct {Maintainerstring `json:"maintainer,omitempty"`Urlstring `json:"url,omitempty"`WebsiteUrlstring `json:"website_url,omitempty"`Emailstring `json:"email,omitempty"`Namestring `json:"name,omitempty"`Help *Help `json:"help,omitempty"`}funcNewPackage¶
typePlatform¶
type Platform struct {Metadata *PlatformMetadata `json:"metadata,omitempty"`Release *PlatformRelease `json:"release,omitempty"`}funcNewPlatform¶
typePlatformMetadata¶
type PlatformMetadata struct {Idstring `json:"id,omitempty"`Maintainerstring `json:"maintainer,omitempty"`Websitestring `json:"website,omitempty"`Emailstring `json:"email,omitempty"`ManuallyInstalledbool `json:"manually_installed,omitempty"`Deprecatedbool `json:"deprecated,omitempty"`Indexedbool `json:"indexed,omitempty"`}funcNewPlatformMetadata¶
func NewPlatformMetadata(p *rpc.PlatformMetadata) *PlatformMetadata
typePlatformRelease¶
type PlatformRelease struct {Namestring `json:"name,omitempty"`Versionstring `json:"version,omitempty"`Types []string `json:"types,omitempty"`Installedbool `json:"installed,omitempty"`Boards []*Board `json:"boards,omitempty"`Help *HelpResource `json:"help,omitempty"`MissingMetadatabool `json:"missing_metadata,omitempty"`Deprecatedbool `json:"deprecated,omitempty"`Compatiblebool `json:"compatible"`}PlatformRelease maps a rpc.PlatformRelease
funcNewPlatformRelease¶
func NewPlatformRelease(in *rpc.PlatformRelease) *PlatformRelease
NewPlatformRelease creates a new result.PlatformRelease from rpc.PlatformRelease
func (*PlatformRelease)FormatName¶
func (p *PlatformRelease) FormatName()string
typePlatformSummary¶
type PlatformSummary struct {Idstring `json:"id,omitempty"`Maintainerstring `json:"maintainer,omitempty"`Websitestring `json:"website,omitempty"`Emailstring `json:"email,omitempty"`ManuallyInstalledbool `json:"manually_installed,omitempty"`Deprecatedbool `json:"deprecated,omitempty"`Indexedbool `json:"indexed,omitempty"`Releasesorderedmap.Map[*semver.Version, *PlatformRelease] `json:"releases,omitempty"`InstalledVersion *semver.Version `json:"installed_version,omitempty"`LatestVersion *semver.Version `json:"latest_version,omitempty"`}PlatformSummary maps a rpc.PlatformSummary
funcNewPlatformSummary¶
func NewPlatformSummary(in *rpc.PlatformSummary) *PlatformSummary
NewPlatformSummary creates a new result.PlatformSummary from rpc.PlatformSummary
func (*PlatformSummary)GetInstalledRelease¶
func (p *PlatformSummary) GetInstalledRelease() *PlatformRelease
GetInstalledRelease returns the installed relase of this platform or nil if none available.
func (*PlatformSummary)GetLatestRelease¶
func (p *PlatformSummary) GetLatestRelease() *PlatformRelease
GetLatestRelease returns the latest relase of this platform or nil if none available.
func (*PlatformSummary)GetPlatformName¶
func (p *PlatformSummary) GetPlatformName()string
GetPlatformName compute the name of the platform based on the installed/available releases.
typePort¶
type Port struct {Addressstring `json:"address,omitempty"`Labelstring `json:"label,omitempty"`Protocolstring `json:"protocol,omitempty"`ProtocolLabelstring `json:"protocol_label,omitempty"`Propertiesorderedmap.Map[string,string] `json:"properties,omitempty"`HardwareIdstring `json:"hardware_id,omitempty"`}typeProgrammer¶
type Programmer struct {Platformstring `json:"platform,omitempty"`Idstring `json:"id,omitempty"`Namestring `json:"name,omitempty"`}funcNewProgrammer¶
func NewProgrammer(c *rpc.Programmer) *Programmer
funcNewProgrammers¶
func NewProgrammers(c []*rpc.Programmer) []*Programmer
typeSearchedLibrary¶
type SearchedLibrary struct {Namestring `json:"name,omitempty"`Releasesorderedmap.Map[*semver.Version, *LibraryRelease] `json:"releases,omitempty"`Latest *LibraryRelease `json:"latest,omitempty"`AvailableVersions []string `json:"available_versions,omitempty"`}funcNewSearchedLibrary¶
func NewSearchedLibrary(l *rpc.SearchedLibrary) *SearchedLibrary
typeSystem¶
type System struct {Checksumstring `json:"checksum,omitempty"`Hoststring `json:"host,omitempty"`ArchiveFilenamestring `json:"archive_filename,omitempty"`Urlstring `json:"url,omitempty"`Sizeint64 `json:"size,omitempty"`}funcNewSystems¶
typeToolsDependency¶
type ToolsDependency struct {Packagerstring `json:"packager,omitempty"`Namestring `json:"name,omitempty"`Versionstring `json:"version,omitempty"`Systems []*System `json:"systems,omitempty"`}funcNewToolsDependencies¶
func NewToolsDependencies(p []*rpc.ToolsDependencies) []*ToolsDependency
funcNewToolsDependency¶
func NewToolsDependency(p *rpc.ToolsDependencies) *ToolsDependency
typeUpdateIndexResponse_ResultResult¶
type UpdateIndexResponse_ResultResult struct {UpdatedIndexes []*IndexUpdateReportResult `json:"updated_indexes,omitempty"`}funcNewUpdateIndexResponse_ResultResult¶
func NewUpdateIndexResponse_ResultResult(resp *rpc.UpdateIndexResponse_Result) *UpdateIndexResponse_ResultResult
typeUpdateLibrariesIndexResponse_ResultResult¶
type UpdateLibrariesIndexResponse_ResultResult struct {LibrariesIndex *IndexUpdateReportResult `json:"libraries_index"`}funcNewUpdateLibrariesIndexResponse_ResultResult¶
func NewUpdateLibrariesIndexResponse_ResultResult(resp *rpc.UpdateLibrariesIndexResponse_Result) *UpdateLibrariesIndexResponse_ResultResult