send

Documentation

Overview

Package send defines a pure computations to compose HTTP request senders

Index

• Constants
• func Params[T any](query T) http.Arrow
• func Send(data interface{}) http.Arrow
• type Authority
• type Header
  • func (header Header) Is(value string) http.Arrow
• type HeaderConnection
  • func (h HeaderConnection) Close(cat *http.Context) error
  • func (h HeaderConnection) KeepAlive(cat *http.Context) error
• type HeaderContent
  • func (h HeaderContent) ApplicationJSON(cat *http.Context) error
  • func (h HeaderContent) Form(cat *http.Context) error
  • func (h HeaderContent) HTML(cat *http.Context) error
  • func (h HeaderContent) Is(value string) http.Arrow
  • func (h HeaderContent) JSON(cat *http.Context) error
  • func (h HeaderContent) Text(cat *http.Context) error
  • func (h HeaderContent) TextHTML(cat *http.Context) error
  • func (h HeaderContent) TextPlain(cat *http.Context) error
• type HeaderContentLength
  • func (h HeaderContentLength) Is(value int64) http.Arrow
• type HeaderTransferEncoding
  • func (h HeaderTransferEncoding) Chunked(cat *http.Context) error
  • func (h HeaderTransferEncoding) Identity(cat *http.Context) error
  • func (h HeaderTransferEncoding) Is(value string) http.Arrow
• type Method
  • func (method Method) URI(addr string) http.Arrow
  • func (method Method) URL(uri string, args ...interface{}) http.Arrow
• type Segment

Constants

const (
	GET    = Method("GET")
	POST   = Method("POST")
	PUT    = Method("PUT")
	DELETE = Method("DELETE")
	PATCH  = Method("PATCH")
)

List of supported built-in method constants

const (
	Accept            = HeaderContent("Accept")
	AcceptCharset     = Header("Accept-Charset")
	AcceptEncoding    = Header("Accept-Encoding")
	AcceptLanguage    = Header("Accept-Language")
	Authorization     = Header("Authorization")
	CacheControl      = Header("Cache-Control")
	Connection        = HeaderConnection("Connection")
	ContentEncoding   = Header("Content-Encoding")
	ContentLength     = HeaderContentLength("Content-Length")
	ContentType       = HeaderContent("Content-Type")
	Cookie            = Header("Cookie")
	Date              = Header("Date")
	Host              = Header("Host")
	IfMatch           = Header("If-Match")
	IfModifiedSince   = Header("If-Modified-Since")
	IfNoneMatch       = Header("If-None-Match")
	IfRange           = Header("If-Range")
	IfUnmodifiedSince = Header("If-Unmodified-Since")
	Origin            = Header("Origin")
	Range             = Header("Range")
	TransferEncoding  = HeaderTransferEncoding("Transfer-Encoding")
	UserAgent         = Header("User-Agent")
	Upgrade           = Header("Upgrade")
)

List of supported HTTP header constants https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields

Functions

func Params

func Params[T any](query T) http.Arrow

Params appends query params to request URL. The arrow takes a struct and converts it to map[string]string. The function fails if input is not convertable to map of strings (e.g. nested struct).

func Send

func Send(data interface{}) http.Arrow

Send payload to destination URL. You can also use native Go data types (e.g. maps, struct, etc) as egress payload. The library implicitly encodes input structures to binary using Content-Type as a hint. The function fails if content type is not supported by the library.

The function accept a "classical" data container such as string, []bytes or io.Reader interfaces.

Types

type Authority

type Authority string

Authority is part of URL, use the type to prevent escaping

type Header

type Header string

Header defines HTTP headers to the request, use combinator to define multiple header values.

  http.Do(
		ø.Header("User-Agent").Is("gurl"),
		ø.Header("Content-Type").Is(content),
	)

func (Header) Is

func (header Header) Is(value string) http.Arrow

Is sets value of HTTP header

type HeaderConnection

type HeaderConnection Header

Lifecycle defines headers for connection management

func (HeaderConnection) Close

func (h HeaderConnection) Close(cat *http.Context) error

Close defines header `???: close`

func (HeaderConnection) KeepAlive

func (h HeaderConnection) KeepAlive(cat *http.Context) error

KeepAlive defines header `???: keep-alive`

type HeaderContent

type HeaderContent Header

Content defines headers for content negotiation

func (HeaderContent) ApplicationJSON

func (h HeaderContent) ApplicationJSON(cat *http.Context) error

ApplicationJSON defines header `???: application/json`

func (HeaderContent) Form

func (h HeaderContent) Form(cat *http.Context) error

Form defined Header `???: application/x-www-form-urlencoded`

func (HeaderContent) HTML

func (h HeaderContent) HTML(cat *http.Context) error

HTML defined Header `???: text/html`

func (HeaderContent) Is

func (h HeaderContent) Is(value string) http.Arrow

Is sets a literval value of HTTP header

func (HeaderContent) JSON

func (h HeaderContent) JSON(cat *http.Context) error

JSON defines header `???: application/json`

func (HeaderContent) Text

func (h HeaderContent) Text(cat *http.Context) error

Text defined Header `???: text/plain`

func (HeaderContent) TextHTML

func (h HeaderContent) TextHTML(cat *http.Context) error

TextHTML defined Header `???: text/html`

func (HeaderContent) TextPlain

func (h HeaderContent) TextPlain(cat *http.Context) error

TextPlain defined Header `???: text/plain`

type HeaderContentLength

type HeaderContentLength Header

Header Content-Length

func (HeaderContentLength) Is

func (h HeaderContentLength) Is(value int64) http.Arrow

Is sets a literval value of HTTP header

type HeaderTransferEncoding

type HeaderTransferEncoding Header

Header TransferEncoding

func (HeaderTransferEncoding) Chunked

func (h HeaderTransferEncoding) Chunked(cat *http.Context) error

Chunked defines header `Transfer-Encoding: chunked`

func (HeaderTransferEncoding) Identity

func (h HeaderTransferEncoding) Identity(cat *http.Context) error

Identity defines header `Transfer-Encoding: identity`

func (HeaderTransferEncoding) Is

func (h HeaderTransferEncoding) Is(value string) http.Arrow

Is sets a literval value of HTTP header

type Method

type Method string

Method is base type for HTTP methods

func (Method) URI

func (method Method) URI(addr string) http.Arrow

URL defines a mandatory parameters to the request such as HTTP method and destination URI

func (Method) URL

func (method Method) URL(uri string, args ...interface{}) http.Arrow

URL defines a mandatory parameters to the request such as HTTP method and destination URL, use Params arrow if you need to supply URL query params.

type Segment

type Segment string

Segment is part of URL, use the type to prevent path escaping