Documentation
¶
Overview ¶
Package pc provides the options for the platform config.
Index ¶
- func Fail(err error) create.SetPlatformConfig
- func Failf(stringFormat string, args ...any) create.SetPlatformConfig
- func WithArchitecture(architecture string) create.SetPlatformConfig
- func WithOS(OS string) create.SetPlatformConfig
- func WithOSFeatures(OSFeatures ...string) create.SetPlatformConfig
- func WithOSVersion(OSVersion string) create.SetPlatformConfig
- func WithVariant(variant string) create.SetPlatformConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Fail ¶
func Fail(err error) create.SetPlatformConfig
Fail is a function that returns an error
note: this is useful for when you want to fail the platform config and append the error to the platform config error collection
func Failf ¶
func Failf(stringFormat string, args ...any) create.SetPlatformConfig
Failf is a function that returns an error
note: this is useful for when you want to fail the platform config and append the error to the platform config error collection
func WithArchitecture ¶
func WithArchitecture(architecture string) create.SetPlatformConfig
WithArchitecture sets the architecture for the platform Parameter:
- architecture: the architecture to be used for the platform
Architecture field specifies the CPU architecture, for example `amd64` or `ppc64le`.
func WithOS ¶
func WithOS(OS string) create.SetPlatformConfig
WithOS sets the OS for the platform Parameter:
- OS: the OS to be used for the platform
OS specifies the operating system, for example `linux` or `windows`.
func WithOSFeatures ¶
func WithOSFeatures(OSFeatures ...string) create.SetPlatformConfig
WithOSFeatures sets the OS features for the platform Parameter:
- OSFeatures: the OS features to be used for the platform
OSFeatures is an optional field specifying an array of strings, each listing a required OS feature (for example on Windows `win32k`).
func WithOSVersion ¶
func WithOSVersion(OSVersion string) create.SetPlatformConfig
WithOSVersion sets the OS version for the platform Parameter:
- OSVersion: the OS version to be used for the platform
OSVersion is an optional field specifying the operating system version, for example on Windows `10.0.14393.1066`.
func WithVariant ¶
func WithVariant(variant string) create.SetPlatformConfig
WithVariant sets the variant for the platform Parameter:
- variant: the variant to be used for the platform
Variant is an optional field specifying a variant of the CPU, for example `v7` to specify ARMv7 when architecture is `arm`.
Types ¶
This section is empty.