Crate warpgate_pdk

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.
• exec_command
  Calls the exec_command host function to execute a command on the host as a synchronous child process.
• host_env
  Calls the get_env_var or set_env_var host function to manage environment variables on the host.
• host_log
  Calls the host_log host function to log a message to the host’s terminal.
• plugin_err
  Return an error message wrapped in [WithReturnCode], for use within #[plugin_fn].
• real_path
  Calls from_virtual_path on the host to convert the provided value to a real path from a virtual path.
• send_request
  Calls the send_request host function to send an HTTP request and return a response. Not OK responses must be handled by the guest.
• virtual_path
  Calls to_virtual_path on the host to convert the provided value to a virtual path from a real path.

Structs

• EmptyInput
  Represents an empty input.
• ExecCommandInput
  Input passed to the exec_command host function.
• ExecCommandOutput
  Output returned from the exec_command host function.
• FileLocator
  A file system locator.
• GitHubLocator
  A GitHub release locator.
• HostEnvironment
  Information about the host environment (the current runtime).
• HostLogInput
  Input passed to the host_log host function.
• SendRequestInput
  Input passed to the send_request host function.
• SendRequestOutput
  Output returned from the send_request host function.
• TestEnvironment
  Information about the current testing environment.
• UrlLocator
  A HTTPS URL locator.

Enums

• 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.
• PluginLocator
  Strategies and protocols for locating plugins.
• PluginLocatorError
  Errors during plugin locator parsing.
• VirtualPath
  A container for WASI virtual paths that can also keep a reference to the original real path.

Functions

• command_exists
  Check whether a command exists or not on the host machine.
• fetchDeprecated
  Fetch the provided request and return a response object.
• fetch_bytes
  Fetch the provided URL and return the response as bytes.
• fetch_json
  Fetch the provided URL and deserialize the response as JSON.
• fetch_text
  Fetch the provided URL and return the response as text.
• fetch_urlDeprecated
  Fetch the provided URL and deserialize the response as JSON.
• fetch_url_bytesDeprecated
  Fetch the provided URL and deserialize the response as bytes.
• fetch_url_textDeprecated
  Fetch the provided URL and return the text response.
• fetch_url_with_cacheDeprecated
  Fetch the provided URL, deserialize the response as JSON, and cache the response in memory for subsequent WASM function calls.
• get_host_environment
  Return information about the host environment.
• get_plugin_id
  Return the ID for the current plugin.
• get_test_environment
  Return information about the testing environment.
• load_git_tags
  Load all Git tags from the provided remote URL. The git binary must exist on the current machine.
• populate_send_request_output

Type Aliases

• AnyResult
  Represents any result (using anyhow).