heimdall

type Headers ¶ added in v0.17.21

type Headers struct {
	// contains filtered or unexported fields
}

Headers provides a read-only, lazily normalized view on HTTP headers.

The underlying http.Header is neither copied nor modified. It must therefore not be mutated for the lifetime of Headers.

Header values are normalized on first access. If multiple values exist for a header, they are joined using a comma. The normalized value is cached and reused for subsequent accesses using the same header name.

Headers is request-scoped and not safe for concurrent use.

func NewHeaders(values http.Header) Headers

func (h *Headers) Get(name string) string

type RedirectError ¶

type RedirectError struct {
	Message    string
	Code       int
	RedirectTo string
}

func (e *RedirectError) Error() string

func (e *RedirectError) Is(target error) bool

type Request ¶

type Request struct {
	RequestFunctions

	Method            string
	URL               *URL
	ClientIPAddresses []string
}

type RequestContext ¶ added in v0.16.0

type RequestContext interface {
	Request() *Request

	AddHeaderForUpstream(name, value string)
	AddCookieForUpstream(name, value string)

	Context() context.Context

	SetPipelineError(err error)

	Outputs() map[string]any
	Results() Results
}

type RequestFunctions ¶

type RequestFunctions interface {
	Header(name string) string
	Cookie(name string) string
	Headers() map[string]string
	Body() any
}

type Result ¶ added in v0.17.21

type Result struct {
	Payload any
	// contains filtered or unexported fields
}

Result represents the result produced by a pipeline step.

Payload is directly available to templates and CEL expressions.

Response headers are intentionally not exposed as a mutable collection. They can only be accessed through Header.

func NewResult(payload any) *Result

func NewResultWithHeaders(payload any, headers http.Header) *Result

func (r *Result) Header(name string) string

func (r *Result) MarshalJSON() ([]byte, error)

func (r *Result) UnmarshalJSON(data []byte) error

type Results ¶ added in v0.17.21

type Results map[string]*Result

Results contains the results produced by executed pipeline steps.

type URL ¶

type URL struct {
	url.URL

	Captures map[string]string
}