Documentation
¶
Index ¶
- func Create() (*rpc.Instance, error)
- func CreateAndInit() *rpc.Instance
- func CreateAndInitWithProfile(profileName string, sketchPath *paths.Path) (*rpc.Instance, *rpc.Profile)
- func CreateInstanceAndRunFirstUpdate() *rpc.Instance
- func FirstUpdate(instance *rpc.Instance) error
- func Init(instance *rpc.Instance)
- func InitWithProfile(instance *rpc.Instance, profileName string, sketchPath *paths.Path) *rpc.Profile
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateAndInit ¶
CreateAndInit return a new initialized instance. If Create fails the CLI prints an error and exits since to execute further operations a valid Instance is mandatory. If Init returns errors they're printed only.
func CreateAndInitWithProfile ¶
func CreateAndInitWithProfile(profileName string, sketchPath *paths.Path) (*rpc.Instance, *rpc.Profile)
CreateAndInitWithProfile returns a new initialized instance using the given profile of the given sketch. If Create fails the CLI prints an error and exits since to execute further operations a valid Instance is mandatory. If Init returns errors they're printed only.
func CreateInstanceAndRunFirstUpdate ¶
CreateInstanceAndRunFirstUpdate creates an instance and runs `FirstUpdate`. It is mandatory for all `update-index` commands to call this
func FirstUpdate ¶
FirstUpdate downloads libraries and packages indexes if they don't exist. This ideally is only executed the first time the CLI is run.
func Init ¶
Init initializes instance by loading installed libraries and platforms. In case of loading failures return a list of errors for each platform or library that we failed to load. Package and library indexes files are automatically updated if the CLI is run for the first time.
func InitWithProfile ¶
func InitWithProfile(instance *rpc.Instance, profileName string, sketchPath *paths.Path) *rpc.Profile
InitWithProfile initializes instance by loading libraries and platforms specified in the given profile of the given sketch. In case of loading failures return a list of errors for each platform or library that we failed to load. Required Package and library indexes files are automatically downloaded.
Types ¶
This section is empty.
Source Files