builder

Documentation

Index

• Variables
• func Header(name string) L.Lens[*Builder, O.Option[string]]
• func WithHeader(name string) func(value string) BuilderBuilder
• type Builder
  • func (builder *Builder) AddHeaderHeader(name, value string) *Builder
  • func (builder *Builder) DelHeader(name string) *Builder
  • func (builder *Builder) GetBody() O.Option[IOE.IOEither[error, []byte]]
  • func (builder *Builder) GetHeader(name string) O.Option[string]
  • func (builder *Builder) GetHeaderValues(name string) []string
  • func (builder *Builder) GetHeaders() http.Header
  • func (builder *Builder) GetMethod() string
  • func (builder *Builder) GetUrl() string
  • func (builder *Builder) Requester() IOEH.Requester
  • func (builder *Builder) SetBody(body O.Option[IOE.IOEither[error, []byte]]) *Builder
  • func (builder *Builder) SetHeader(name, value string) *Builder
  • func (builder *Builder) SetHeaders(headers http.Header) *Builder
  • func (builder *Builder) SetMethod(method string) *Builder
  • func (builder *Builder) SetUrl(url string) *Builder
• type BuilderBuilder
  • func WithFormData(value url.Values) BuilderBuilder
  • func WithJson[T any](data T) BuilderBuilder
  • func WithoutHeader(name string) BuilderBuilder

Variables

var (
	// Default is the default builder
	Default = &Builder{method: O.Some(defaultMethod()), headers: make(http.Header), body: noBody}

	// Url is a [L.Lens] for the URL
	Url = L.MakeLensRef((*Builder).GetUrl, (*Builder).SetUrl)
	// Method is a [L.Lens] for the HTTP method
	Method = L.MakeLensRef((*Builder).GetMethod, (*Builder).SetMethod)
	// Body is a [L.Lens] for the request body
	Body = L.MakeLensRef((*Builder).GetBody, (*Builder).SetBody)
	// Headers is a [L.Lens] for the complete set of request headers
	Headers = L.MakeLensRef((*Builder).GetHeaders, (*Builder).SetHeaders)

	// WithMethod creates a [BuilderBuilder] for a certain method
	WithMethod = Method.Set
	// WithUrl creates a [BuilderBuilder] for a certain method
	WithUrl = Url.Set
	// WithHeaders creates a [BuilderBuilder] for a set of headers
	WithHeaders = Headers.Set
	// WithBody creates a [BuilderBuilder] for a request body
	WithBody = F.Flow2(
		O.Of[IOE.IOEither[error, []byte]],
		Body.Set,
	)
	// WithContentType adds the content type header
	WithContentType = WithHeader("Content-Type")

	// WithGet adds the [http.MethodGet] method
	WithGet = WithMethod(http.MethodGet)
	// WithPost adds the [http.MethodPost] method
	WithPost = WithMethod(http.MethodPost)
	// WithPut adds the [http.MethodPut] method
	WithPut = WithMethod(http.MethodPut)
	// WithDelete adds the [http.MethodDelete] method
	WithDelete = WithMethod(http.MethodDelete)

	// Requester creates a requester from a builder
	Requester = (*Builder).Requester

	// WithoutBody creates a [BuilderBuilder] to remove the body
	WithoutBody = Body.Set(noBody)
)

Functions

func Header

func Header(name string) L.Lens[*Builder, O.Option[string]]

Header returns a [L.Lens] for a single header

func WithHeader

func WithHeader(name string) func(value string) BuilderBuilder

WithHeader creates a BuilderBuilder for a certain header

Types

type Builder

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

func (*Builder) AddHeaderHeader

func (builder *Builder) AddHeaderHeader(name, value string) *Builder

func (*Builder) DelHeader

func (builder *Builder) DelHeader(name string) *Builder

func (*Builder) GetBody

func (builder *Builder) GetBody() O.Option[IOE.IOEither[error, []byte]]

func (*Builder) GetHeader

func (builder *Builder) GetHeader(name string) O.Option[string]

func (*Builder) GetHeaderValues

func (builder *Builder) GetHeaderValues(name string) []string

func (*Builder) GetHeaders

func (builder *Builder) GetHeaders() http.Header

func (*Builder) GetMethod

func (builder *Builder) GetMethod() string

func (*Builder) GetUrl

func (builder *Builder) GetUrl() string

func (*Builder) Requester

func (builder *Builder) Requester() IOEH.Requester

func (*Builder) SetBody

func (builder *Builder) SetBody(body O.Option[IOE.IOEither[error, []byte]]) *Builder

func (*Builder) SetHeader

func (builder *Builder) SetHeader(name, value string) *Builder

func (*Builder) SetHeaders

func (builder *Builder) SetHeaders(headers http.Header) *Builder

func (*Builder) SetMethod

func (builder *Builder) SetMethod(method string) *Builder

func (*Builder) SetUrl

func (builder *Builder) SetUrl(url string) *Builder

type BuilderBuilder

type BuilderBuilder = func(*Builder) *Builder

BuilderBuilder returns a function that transforms a builder

func WithFormData

func WithFormData(value url.Values) BuilderBuilder

WithFormData creates a BuilderBuilder to send form data payload

func WithJson

func WithJson[T any](data T) BuilderBuilder

WithJson creates a BuilderBuilder to send JSON payload

func WithoutHeader

func WithoutHeader(name string) BuilderBuilder

WithoutHeader creates a BuilderBuilder to remove a certain header