httphelper

README

httphelper

Helpers for Go's net/http package.

Documentation

Overview

Package httphelper contains net/http package helpers.

Index

• func AuthBasic(userid, password string) string
• func ErrorOptionWithObject() func(o *ErrorOptions)
• type Error
  • func NewError[E any](rs *http.Response, opts ...func(o *ErrorOptions)) (*Error[E], error)
  • func (e *Error[B]) Error() string
• type ErrorOptions

Functions

func AuthBasic

func AuthBasic(userid, password string) string

AuthBasic returns Basic authorization value.

func ErrorOptionWithObject

func ErrorOptionWithObject() func(o *ErrorOptions)

ErrorOptionWithObject turns on Error's Object JSON deserialization from HTTP response body.

Types

type Error

type Error[E any] struct {
	StatusCode int    `json:"status_code"`
	Status     string `json:"status"`
	Object     E      `json:"object,omitempty"`
}

Error represents a HTTP error. Object (if turned on in options) is deserialized from JSON read from HTTP response body (if any).

func NewError

func NewError[E any](rs *http.Response, opts ...func(o *ErrorOptions)) (*Error[E], error)

NewError creates Error from http.Response.

func (*Error[B]) Error

func (e *Error[B]) Error() string

Error implements the [error] interface.

type ErrorOptions

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

ErrorOptions contains Error options.