requester

Documentation

Index

• Constants
• func Code(err error) int
• func StatusCode(err error) int
• type Client
  • func NewClient(opts ...ClientOption) *Client
  • func (c *Client) Do(opts ...RequestOption) (*Response, error)
• type ClientOption
  • func WithDefaultOptions(opts ...RequestOption) ClientOption
  • func WithHTTPClient(httpClient *http.Client) ClientOption
  • func WithRequestValidation(fn RequestValidatorFunc) ClientOption
• type Request
  • func NewRequest(opts ...RequestOption) (*Request, error)
• type RequestOption
  • func WithBody(v interface{}) RequestOption
  • func WithContext(ctx context.Context) RequestOption
  • func WithForm(v interface{}) RequestOption
  • func WithHeader(header map[string]string) RequestOption
  • func WithHost(host string) RequestOption
  • func WithJSON(v interface{}) RequestOption
  • func WithMethod(method string) RequestOption
  • func WithPath(path string) RequestOption
  • func WithQuery(query url.Values) RequestOption
  • func WithRequestLogger(w io.Writer) RequestOption
  • func WithRequestTrace(ctx context.Context) RequestOption
  • func WithResponseLogger(w io.Writer) RequestOption
  • func WithURL(url string) RequestOption
  • func WithXML(v interface{}) RequestOption
• type RequestValidatorFunc
• type Response
  • func (r *Response) JSON(v interface{}) error
  • func (r *Response) XML(v interface{}) error

Constants

const (
	CodeUnknown         int = 0
	CodeInvalidBody     int = 1
	CodeBadResponseCode int = 2
	CodeEncodingError   int = 3
	CodeInvalidForm     int = 4
	CodeMissingURL      int = 5
)

Functions

func Code

func Code(err error) int

func StatusCode

func StatusCode(err error) int

Types

type Client

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

func NewClient

func NewClient(opts ...ClientOption) *Client

func (*Client) Do

func (c *Client) Do(opts ...RequestOption) (*Response, error)

type ClientOption

type ClientOption func(*Client)

func WithDefaultOptions

func WithDefaultOptions(opts ...RequestOption) ClientOption

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) ClientOption

func WithRequestValidation

func WithRequestValidation(fn RequestValidatorFunc) ClientOption

type Request

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

func NewRequest

func NewRequest(opts ...RequestOption) (*Request, error)

type RequestOption

type RequestOption func(*Request) error

func WithBody

func WithBody(v interface{}) RequestOption

func WithContext

func WithContext(ctx context.Context) RequestOption

func WithForm

func WithForm(v interface{}) RequestOption

func WithHeader

func WithHeader(header map[string]string) RequestOption

func WithHost

func WithHost(host string) RequestOption

func WithJSON

func WithJSON(v interface{}) RequestOption

func WithMethod

func WithMethod(method string) RequestOption

func WithPath

func WithPath(path string) RequestOption

func WithQuery

func WithQuery(query url.Values) RequestOption

func WithRequestLogger

func WithRequestLogger(w io.Writer) RequestOption

func WithRequestTrace

func WithRequestTrace(ctx context.Context) RequestOption

WithRequestTrace returns a RequestOption that will trace the request using datadog. Side Effect: adds context to request

func WithResponseLogger

func WithResponseLogger(w io.Writer) RequestOption

func WithURL

func WithURL(url string) RequestOption

func WithXML

func WithXML(v interface{}) RequestOption

type RequestValidatorFunc

type RequestValidatorFunc func(*http.Request) error

type Response

type Response struct {
	*http.Response
}

func (*Response) JSON

func (r *Response) JSON(v interface{}) error

func (*Response) XML

func (r *Response) XML(v interface{}) error