http

Documentation

Overview

Package http provides an HTTP client for Tarmac WebAssembly functions.

Requests are serialized via protobuf and sent to the host using waPC. The Client interface offers convenience methods (Get, Post, Put, Delete) and a Do method for custom requests. Errors use sentinel values combined with the underlying cause and can be checked with errors.Is.

Index

• Variables
• type Client
  • func New(config Config) (Client, error)
• type Config
• type Request
  • func NewRequest(method, urlString string, body io.Reader) (*Request, error)
• type Response

Variables

var (
	// ErrInvalidURL indicates a malformed or unsupported URL.
	ErrInvalidURL = errors.New("invalid URL provided")
	// ErrMarshalRequest wraps failures while encoding the request payload.
	ErrMarshalRequest = errors.New("failed to create request")
	// ErrReadBody wraps failures while reading a request body stream.
	ErrReadBody = errors.New("failed to read request body")
	// ErrUnmarshalResponse wraps failures while decoding the host response.
	ErrUnmarshalResponse = errors.New("failed to unmarshal response")
	// ErrHostCall wraps errors returned from the waPC host call.
	ErrHostCall = errors.New("host call failed")
	// ErrInvalidMethod indicates an HTTP method not permitted by NewRequest.
	ErrInvalidMethod = errors.New("invalid HTTP method")
)

Types

type Client

type Client interface {
	Get(url string) (*Response, error)
	Post(url, contentType string, body io.Reader) (*Response, error)
	Put(url, contentType string, body io.Reader) (*Response, error)
	Delete(url string) (*Response, error)
	Do(req *Request) (*Response, error)
}

Client provides an interface for making HTTP requests.

func New

func New(config Config) (Client, error)

New creates a new HTTP client with the provided configuration.

type Config

type Config struct {
	// SDKConfig provides the runtime namespace for host calls.
	SDKConfig sdk.RuntimeConfig
	// InsecureSkipVerify disables TLS verification when supported.
	InsecureSkipVerify bool
	// HostCall overrides the waPC host function used for requests.
	HostCall func(string, string, string, []byte) ([]byte, error)
}

Config configures the HTTP client behavior and host integration.

SDKConfig supplies the namespace used when making waPC host calls. If the Namespace is empty, it defaults to sdk.DefaultNamespace during New. InsecureSkipVerify controls TLS verification behavior on the host side when supported by the runtime. HostCall allows tests to inject a custom host function; when nil, the client uses wapc.HostCall.

type Request

type Request struct {
	// Method is the HTTP method (e.g., GET, POST).
	Method string
	// URL is the full request URL; Host must be non-empty.
	URL *url.URL
	// Header holds request headers. Nil is treated as empty.
	Header http.Header
	// Body is an optional request body stream.
	Body io.ReadCloser
}

Request represents an HTTP request to be sent by the client.

func NewRequest

func NewRequest(method, urlString string, body io.Reader) (*Request, error)

NewRequest creates a new Request object to use with the Do method.

This function provides a way to create custom HTTP requests with specific methods, URLs and body content.

type Response

type Response struct {
	// Status is the HTTP status text (e.g., "OK").
	Status string
	// StatusCode is the numeric HTTP status code (e.g., 200).
	StatusCode int
	// Header contains response headers. Nil is treated as empty.
	Header http.Header
	// Body is the response payload stream. It may be nil for empty bodies.
	Body io.ReadCloser
}

Response represents an HTTP response returned by the host.