requestconfig

Documentation

Index

• func ExecuteNewRequest(ctx context.Context, method string, u string, body interface{}, ...) error
• type RequestConfig
  • func NewRequestConfig(ctx context.Context, method string, u string, body interface{}, ...) (*RequestConfig, error)
  • func (cfg *RequestConfig) Apply(opts ...func(*RequestConfig) error) error
  • func (cfg *RequestConfig) Clone(ctx context.Context) *RequestConfig
  • func (cfg *RequestConfig) Execute() error

Functions

func ExecuteNewRequest

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

Types

type RequestConfig

type RequestConfig struct {
	MaxRetries     int
	RequestTimeout time.Duration
	Context        context.Context
	Request        *http.Request
	BaseURL        *url.URL
	HTTPClient     *http.Client
	Middlewares    []middleware
	APIKey         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
	OrganizationID string
	WebhookKey     string
	Buffer         []byte
}

RequestConfig represents all the state related to one request.

Editing the variables inside RequestConfig directly is unstable api. Prefer composing func(\*RequestConfig) error instead if possible.

func NewRequestConfig

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

func (*RequestConfig) Apply

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

func (*RequestConfig) Clone

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

func (*RequestConfig) Execute

func (cfg *RequestConfig) Execute() error