Crate proto_pdk_api

Macros

• anyhow
  Construct an ad-hoc error from a string or existing non-anyhow error value.
• api_enum
  Wrap an enum with common derives and serde required attributes.
• api_struct
  Wrap a struct with common derives and serde required attributes.

Structs

• ArchiveSource
  Source code is contained in an archive.
• BuildInstructionsInput
  Input passed to the build_instructions function.
• BuildInstructionsOutput
  Output returned by the build_instructions function.
• CalVer
  Container for a calendar version.
• CommandInstruction
  A command and its parameters to be executed as a child process.
• DependencyConfig
  Configuration for one or many system dependencies (packages).
• DetectVersionOutput
  Output returned by the detect_version_files function.
• DownloadPrebuiltInput
  Input passed to the download_prebuilt function.
• DownloadPrebuiltOutput
  Output returned by the download_prebuilt function.
• EmptyInput
  Represents an empty input.
• ExecCommandInput
  Input passed to the exec_command host function.
• ExecCommandOutput
  Output returned from the exec_command host function.
• ExecutableConfig
  Configuration for generated shim and symlinked binary files.
• GitHubLocator
  A GitHub release locator.
• GitSource
  Source code is located in a Git repository.
• HostEnvironment
  Information about the host environment (the current runtime).
• HostLogInput
  Input passed to the host_log host function.
• InstallHook
  Input passed to the pre_install and post_install hooks, while a proto install command is running.
• LoadVersionsInput
  Input passed to the load_versions function.
• LoadVersionsOutput
  Output returned by the load_versions function.
• LocateExecutablesInput
  Input passed to the locate_executables function.
• LocateExecutablesOutput
  Output returned by the locate_executables function.
• NativeInstallInput
  Input passed to the native_install function.
• NativeInstallOutput
  Output returned by the native_install function.
• NativeUninstallInput
  Input passed to the native_uninstall function.
• NativeUninstallOutput
  Output returned by the native_uninstall function.
• ParseVersionFileInput
  Input passed to the parse_version_file function.
• ParseVersionFileOutput
  Output returned by the parse_version_file function.
• ResolveVersionInput
  Input passed to the resolve_version function.
• ResolveVersionOutput
  Output returned by the resolve_version function.
• RunHook
  Input passed to the pre_run hook, before a proto run command or language binary is ran.
• RunHookResult
  Output returned from the pre_run hook.
• SemVer
  Container for a semantic version.
• SyncManifestInput
  Input passed to the sync_manifest function.
• SyncManifestOutput
  Output returned by the sync_manifest function.
• SyncShellProfileInput
  Input passed to the sync_shell_profile function.
• SyncShellProfileOutput
  Output returned by the sync_shell_profile function.
• TestEnvironment
  Information about the current testing environment.
• ToolContext
  Information about the current state of the tool.
• ToolInventoryMetadata
  Controls aspects of the tool inventory.
• ToolMetadataInput
  Input passed to the register_tool function.
• ToolMetadataOutput
  Output returned by the register_tool function.
• UnpackArchiveInput
  Input passed to the unpack_archive function.
• UnresolvedParser
• VerifyChecksumInput
  Output returned by the verify_checksum function.
• VerifyChecksumOutput
  Output returned by the verify_checksum function.
• Version
  SemVer version as defined by https://semver.org.
• VersionReq
  SemVer version requirement describing the intersection of some version comparators, such as >=1.2.3, <1.8.

Enums

• BuildInstruction
  An instruction to execute.
• BuildRequirement
  Is required and must exist in the current environment.
• DependencyName
  A system dependency name in multiple formats.
• HostArch
  Architecture of the system environment.
• HostLibc
  Libc being used in the system environment.
• HostLogTarget
  Target where host logs should be written to.
• HostOS
  Operating system of the current environment.
• ParseKind
• ParsePart
• PluginError
  Errors that may occur from within a plugin.
• PluginLocator
  Strategies and protocols for locating plugins.
• PluginLocatorError
  Errors during plugin locator parsing.
• PluginType
  Supported types of plugins.
• SourceLocation
  The location in which source code can be acquired.
• SpecError
• StringOrVec
  Either a string, or a list of strings.
• SystemDependency
  Represents a system dependency (one or many packages) to install.
• SystemPackageManager
  Package manager of the system environment.
• UnresolvedVersionSpec
  Represents an unresolved version or alias that must be resolved to a fully-qualified version.
• VersionSpec
  Represents a resolved version or alias.
• VirtualPath
  A container for WASI virtual paths that can also keep a reference to the original real path.

Functions

• clean_version_req_string
  Cleans a version requirement string by removing * version parts, and correcting AND operators.
• clean_version_string
  Cleans a potential version string by removing a leading v or V.
• get_calver_regex
  Get a regex pattern that matches calendar versions (calver). For example: 2024-02-26, 2024-12, 2024-01-alpha, etc.
• get_semver_regex
  Get a regex pattern that matches semantic versions (semver). For example: 1.2.3, 6.5.4, 7.8.9-alpha, etc.
• is_alias_name
  Returns true if the provided value is an alias. An alias is a word that maps to version, for example, “latest” -> “1.2.3”.
• is_calver
  Returns true if the provided value is a calendar version string.
• is_semver
  Returns true if the provided value is a semantic version string.
• parse
  Parse the provided string and determine the output format. Since an unresolved version can be many things, such as an alias, version requirement, semver, or calver, we need to parse this manually to determine the correct output.
• parse_multi
  Parse the provided string as a list of version requirements, as separated by ||. Each requirement will be parsed individually with parse.

Type Aliases

• AnyResult
  Represents any result (using anyhow).