requestconfig

Documentation

Index

• func ExecuteNewRequest(ctx context.Context, method string, u string, body interface{}, ...) error
• func UseDefaultParam[T any](dst *param.Field[T], src *T)
• type HTTPDoer
• type PreRequestOptionFunc
  • func (s PreRequestOptionFunc) Apply(r *RequestConfig) error
• type RequestConfig
  • func NewRequestConfig(ctx context.Context, method string, u string, body interface{}, ...) (*RequestConfig, error)
  • func PreRequestOptions(opts ...RequestOption) (RequestConfig, error)
  • func (cfg *RequestConfig) Apply(opts ...RequestOption) error
  • func (cfg *RequestConfig) Clone(ctx context.Context) *RequestConfig
  • func (cfg *RequestConfig) Execute() (err error)
• type RequestOption
• type RequestOptionFunc
  • func (s RequestOptionFunc) Apply(r *RequestConfig) error

Functions

func ExecuteNewRequest

func ExecuteNewRequest(ctx context.Context, method string, u string, body interface{}, dst interface{}, opts ...RequestOption) error

func UseDefaultParam

func UseDefaultParam[T any](dst *param.Field[T], src *T)

Types

type HTTPDoer

type HTTPDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

This interface is primarily used to describe an *http.Client, but also supports custom HTTP implementations.

type PreRequestOptionFunc

type PreRequestOptionFunc func(*RequestConfig) error

func (PreRequestOptionFunc) Apply

func (s PreRequestOptionFunc) Apply(r *RequestConfig) error

type RequestConfig

type RequestConfig struct {
	MaxRetries     int
	RequestTimeout time.Duration
	Context        context.Context
	Request        *http.Request
	BaseURL        *url.URL
	CustomHTTPDoer HTTPDoer
	HTTPClient     *http.Client
	Middlewares    []middleware
	BearerToken    string
	// If ResponseBodyInto not nil, then we will attempt to deserialize into
	// ResponseBodyInto. If Destination is a []byte, then it will return the body as
	// is.
	ResponseBodyInto interface{}
	// ResponseInto copies the \*http.Response of the corresponding request into the
	// given address
	ResponseInto **http.Response
	Body         io.Reader
}

RequestConfig represents all the state related to one request.

Editing the variables inside RequestConfig directly is unstable api. Prefer composing the RequestOption instead if possible.

func NewRequestConfig

func NewRequestConfig(ctx context.Context, method string, u string, body interface{}, dst interface{}, opts ...RequestOption) (*RequestConfig, error)

func PreRequestOptions

func PreRequestOptions(opts ...RequestOption) (RequestConfig, error)

func (*RequestConfig) Apply

func (cfg *RequestConfig) Apply(opts ...RequestOption) error

func (*RequestConfig) Clone

func (cfg *RequestConfig) Clone(ctx context.Context) *RequestConfig

func (*RequestConfig) Execute

func (cfg *RequestConfig) Execute() (err error)

type RequestOption

type RequestOption interface {
	Apply(*RequestConfig) error
}

type RequestOptionFunc

type RequestOptionFunc func(*RequestConfig) error

func (RequestOptionFunc) Apply

func (s RequestOptionFunc) Apply(r *RequestConfig) error