Crate proto_pdk

Macros

• err
• exec_command
• host_env
• host_log
• json_enum
• json_struct
• permutations

Structs

• BuildInstructionsInput
  Input passed to the build_instructions function.
• BuildInstructionsOutput
  Output returned by the build_instructions function.
• CreateShimsInput
  Input passed to the create_shims function.
• CreateShimsOutput
  Output returned by the create_shims function.
• DependencyConfig
• 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.
• HostEnvironment
  Information about the host environment (the current runtime).
• InstallGlobalInput
  Input passed to the install_global function.
• InstallGlobalOutput
  Output returned by the install_global 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.
• LocateBinsInput
  Input passed to the locate_bins function.
• LocateBinsOutput
  Output returned by the locate_bins 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 and post_run hooks, while a proto run command or language binary is running.
• ShimConfig
  Configuration for individual shim files.
• 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.
• 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.
• UninstallGlobalInput
  Input passed to the uninstall_global function.
• UninstallGlobalOutput
  Output returned by the uninstall_global function.
• UnpackArchiveInput
  Input passed to the unpack_archive function.
• UserConfigSettings
  The current user’s proto configuration.
• 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
• DependencyName
• HostArch
  Architecture of the host environment.
• HostLogInput
  Input passed to the host_log host function.
• HostOS
  Operating system of the host environment.
• PluginError
• PluginType
  Supported types of plugins.
• SourceLocation
• SystemDependency
• SystemPackageManager
• VirtualPath
  A container for WASI virtual paths that can also keep a reference to the original real path.

Functions

• check_supported_os_and_arch
  Validate the current host OS and architecture against the supported list of target permutations.
• command_exists
  Check whether a command exists or not on the host machine.
• fetch
  Fetch the provided request and deserialize the response as JSON.
• fetch_url
  Fetch the provided URL and deserialize the response as JSON.
• fetch_url_text
  Fetch the provided URL and return the text response.
• fetch_url_with_cache
  Fetch the provided URL, deserialize the response as JSON, and cache the response in memory for the duration of the WASM function call. Caches does not persist across function calls.
• format_bin_name
  Return the name of the binary for the provided name and OS. On Windows, will append “.exe”, and keep as-is on other OS’s.
• get_proto_environment
  Return information about proto and the host environment.
• get_proto_user_config
  Return the loaded proto user configuration (~/.proto/config.toml). Does not include plugins!
• get_target_triple
  Return a Rust target triple for the current host OS and architecture.
• get_tool_id
  Get the active tool ID for the current WASM instance.
• is_musl
  Detect whether the current OS is utilizing musl instead of gnu.
• load_git_tags
  Load all git tags from the provided remote URL. The git binary must exist on the current machine.