client

Documentation

Overview

Package client implements the internal HTTP request/response handling

Package client implements the internal HTTP request/response handling

Package client implements the internal HTTP request/response handling

Index

• func Stream(r *Response, handler func([]byte) error, opts ...StreamOption) error
• func StreamInto(r *Response, handler interface{}, opts ...StreamOption) error
• func StreamJSON(r *Response, handler func(json.RawMessage) error, opts ...StreamOption) error
• func StreamLines(r *Response, handler func([]byte) error, opts ...StreamOption) error
• func StreamSSE(reader io.ReadCloser, handler EventSourceHandler) error
• type Event
• type EventFullHandlerFunc
  • func (l *EventFullHandlerFunc) OnClose() error
  • func (l *EventFullHandlerFunc) OnEvent(event Event) error
  • func (l *EventFullHandlerFunc) OnOpen() error
• type EventHandlerFunc
  • func (f EventHandlerFunc) OnEvent(event Event) error
• type EventSourceFullHandler
• type EventSourceHandler
• type HTTPClient
• type Request
  • func (r *Request) Do(ctx context.Context) (*Response, error)
  • func (r *Request) Stream(ctx context.Context, handler func([]byte) error, opts ...StreamOption) error
  • func (r *Request) StreamInto(ctx context.Context, handler interface{}) error
  • func (r *Request) StreamJSON(ctx context.Context, handler func(json.RawMessage) error) error
  • func (r *Request) StreamLines(ctx context.Context, handler func([]byte) error, opts ...StreamOption) error
  • func (r *Request) StreamSSE(ctx context.Context, handler EventSourceHandler) error
  • func (r *Request) WithBody(body interface{}) *Request
  • func (r *Request) WithHeader(key, value string) *Request
  • func (r *Request) WithHeaders(headers map[string]string) *Request
  • func (r *Request) WithMiddleware(m middleware.Middleware) *Request
  • func (r *Request) WithMiddlewares(middlewares ...middleware.Middleware) *Request
  • func (r *Request) WithQuery(key, value string) *Request
  • func (r *Request) WithQueryMap(params map[string]string) *Request
  • func (r *Request) WithTimeout(timeout time.Duration) *Request
• type Response
  • func (r *Response) Bytes() ([]byte, error)
  • func (r *Response) Close() error
  • func (r *Response) Consume() error
  • func (r *Response) IsClientError() bool
  • func (r *Response) IsError() bool
  • func (r *Response) IsRedirect() bool
  • func (r *Response) IsServerError() bool
  • func (r *Response) IsSuccess() bool
  • func (r *Response) JSON(v interface{}) error
  • func (r *Response) Pipe(ch chan<- []byte) error
  • func (r *Response) Stream(handler func([]byte) error, opts ...StreamOption) error
  • func (r *Response) StreamInto(handler interface{}, opts ...StreamOption) error
  • func (r *Response) StreamJSON(handler func(json.RawMessage) error, opts ...StreamOption) error
  • func (r *Response) StreamLines(handler func([]byte) error, opts ...StreamOption) error
  • func (r *Response) StreamSSE(handler EventSourceHandler) error
  • func (r *Response) String() (string, error)
  • func (r *Response) WriteTo(w io.Writer) (int64, error)
• type StreamOption
  • func WithBufferSize(size int) StreamOption
  • func WithByteDelimiter(delimiter byte) StreamOption
  • func WithContentType(contentType string) StreamOption
  • func WithDelimiter(delimiter string) StreamOption

Functions

func Stream

func Stream(r *Response, handler func([]byte) error, opts ...StreamOption) error

Stream processes a response stream with the provided handler function. The handler is called for each chunk of data. If the handler returns an error, streaming stops and the error is returned.

func StreamInto

func StreamInto(r *Response, handler interface{}, opts ...StreamOption) error

StreamInto processes a response stream as JSON objects and unmarshals each object into a new instance of the provided type, then passes it to the handler function.

func StreamJSON

func StreamJSON(r *Response, handler func(json.RawMessage) error, opts ...StreamOption) error

StreamJSON processes a response stream as JSON objects with the provided handler function. The handler is called for each JSON object. If the handler returns an error, streaming stops and the error is returned.

func StreamLines

func StreamLines(r *Response, handler func([]byte) error, opts ...StreamOption) error

StreamLines processes a response stream line by line with the provided handler function. The handler is called for each line. If the handler returns an error, streaming stops and the error is returned.

func StreamSSE

func StreamSSE(reader io.ReadCloser, handler EventSourceHandler) error

StreamSSE processes a Server-Sent Events stream with the provided handler.

Types

type Event

type Event struct {
	ID    string
	Event string
	Data  string
	Retry int
}

Event represents a Server-Sent Event

type EventFullHandlerFunc

type EventFullHandlerFunc struct {
	OnEventFunc func(event Event) error
	OnOpenFunc  func() error
	OnCloseFunc func() error
}

EventFullHandlerFunc represents a function-based handler with lifecycle support

func (*EventFullHandlerFunc) OnClose

func (l *EventFullHandlerFunc) OnClose() error

OnClose implements EventSourceFullHandler interface

func (*EventFullHandlerFunc) OnEvent

func (l *EventFullHandlerFunc) OnEvent(event Event) error

OnEvent implements EventSourceHandler interface

func (*EventFullHandlerFunc) OnOpen

func (l *EventFullHandlerFunc) OnOpen() error

OnOpen implements EventSourceFullHandler interface

type EventHandlerFunc

type EventHandlerFunc func(event Event) error

EventHandlerFunc is a function type for handling SSE events

func (EventHandlerFunc) OnEvent

func (f EventHandlerFunc) OnEvent(event Event) error

OnEvent implements EventSourceHandler interface

type EventSourceFullHandler

type EventSourceFullHandler interface {
	EventSourceHandler
	OnOpen() error
	OnClose() error
}

EventSourceFullHandler extends EventSourceHandler with lifecycle methods

type EventSourceHandler

type EventSourceHandler interface {
	OnEvent(event Event) error
}

EventSourceHandler handles incoming Server-Sent Events

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
	GetMiddlewares() []middleware.Middleware
}

HTTPClient defines the interface for the HTTP client

type Request

type Request struct {
	Method  string
	URL     string
	Headers http.Header
	Query   url.Values
	Body    interface{}
	Client  HTTPClient
	// contains filtered or unexported fields
}

Request represents a prepared HTTP request with middleware support

func (*Request) Do

func (r *Request) Do(ctx context.Context) (*Response, error)

Do executes the request and returns the response

func (*Request) Stream

func (r *Request) Stream(ctx context.Context, handler func([]byte) error, opts ...StreamOption) error

Stream executes the request and streams the response as raw bytes

func (*Request) StreamInto

func (r *Request) StreamInto(ctx context.Context, handler interface{}) error

StreamInto executes the request and unmarshals each JSON object into the specified type

func (*Request) StreamJSON

func (r *Request) StreamJSON(ctx context.Context, handler func(json.RawMessage) error) error

StreamJSON executes the request and streams the response as JSON objects

func (*Request) StreamLines

func (r *Request) StreamLines(ctx context.Context, handler func([]byte) error, opts ...StreamOption) error

StreamLines executes the request and streams the response line by line

func (*Request) StreamSSE

func (r *Request) StreamSSE(ctx context.Context, handler EventSourceHandler) error

StreamSSE executes the request and streams the response as Server-Sent Events

func (*Request) WithBody

func (r *Request) WithBody(body interface{}) *Request

WithBody sets the request body

func (*Request) WithHeader

func (r *Request) WithHeader(key, value string) *Request

WithHeader sets a header for this request

func (*Request) WithHeaders

func (r *Request) WithHeaders(headers map[string]string) *Request

WithHeaders sets multiple headers for this request

func (*Request) WithMiddleware

func (r *Request) WithMiddleware(m middleware.Middleware) *Request

WithMiddleware adds middleware specific to this request

func (*Request) WithMiddlewares

func (r *Request) WithMiddlewares(middlewares ...middleware.Middleware) *Request

WithMiddlewares adds multiple middlewares specific to this request

func (*Request) WithQuery

func (r *Request) WithQuery(key, value string) *Request

WithQuery adds a query parameter to the request

func (*Request) WithQueryMap

func (r *Request) WithQueryMap(params map[string]string) *Request

WithQueryMap adds multiple query parameters to the request

func (*Request) WithTimeout

func (r *Request) WithTimeout(timeout time.Duration) *Request

WithTimeout sets a timeout specific to this request

type Response

type Response struct {
	*http.Response
}

Response wraps the standard http.Response with additional utility methods

func (*Response) Bytes

func (r *Response) Bytes() ([]byte, error)

Bytes reads the entire response body and returns it as a byte slice

func (*Response) Close

func (r *Response) Close() error

Close closes the response body

func (*Response) Consume

func (r *Response) Consume() error

Consume reads and discards the response body

func (*Response) IsClientError

func (r *Response) IsClientError() bool

IsClientError returns true if the status code is 4xx

func (*Response) IsError

func (r *Response) IsError() bool

IsError returns true if the status code indicates an error (4xx or 5xx)

func (*Response) IsRedirect

func (r *Response) IsRedirect() bool

IsRedirect returns true if the status code is 3xx

func (*Response) IsServerError

func (r *Response) IsServerError() bool

IsServerError returns true if the status code is 5xx

func (*Response) IsSuccess

func (r *Response) IsSuccess() bool

IsSuccess returns true if the status code is between 200 and 299

func (*Response) JSON

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

JSON unmarshals the response body into the provided interface

func (*Response) Pipe

func (r *Response) Pipe(ch chan<- []byte) error

Pipe allows for piping the response body to the provided channel

func (*Response) Stream

func (r *Response) Stream(handler func([]byte) error, opts ...StreamOption) error

Stream processes a response stream with the provided handler function. The handler is called for each chunk of data.

func (*Response) StreamInto

func (r *Response) StreamInto(handler interface{}, opts ...StreamOption) error

StreamInto processes a response stream as JSON objects and unmarshals each object into a new instance of the provided type, then passes it to the handler function.

func (*Response) StreamJSON

func (r *Response) StreamJSON(handler func(json.RawMessage) error, opts ...StreamOption) error

StreamJSON processes a response stream as JSON objects with the provided handler function.

func (*Response) StreamLines

func (r *Response) StreamLines(handler func([]byte) error, opts ...StreamOption) error

StreamLines processes a response stream line by line with the provided handler function.

func (*Response) StreamSSE

func (r *Response) StreamSSE(handler EventSourceHandler) error

StreamSSE processes a Server-Sent Events stream with the provided handler function.

func (*Response) String

func (r *Response) String() (string, error)

String reads the entire response body and returns it as a string

func (*Response) WriteTo

func (r *Response) WriteTo(w io.Writer) (int64, error)

WriteTo implements io.WriterTo, streaming the response body to the provided writer

type StreamOption

type StreamOption func(*streamOptions)

StreamOption represents options for stream processing

func WithBufferSize

func WithBufferSize(size int) StreamOption

WithBufferSize sets the buffer size for stream reading

func WithByteDelimiter

func WithByteDelimiter(delimiter byte) StreamOption

WithByteDelimiter sets a byte delimiter for stream reading

func WithContentType

func WithContentType(contentType string) StreamOption

WithContentType sets the expected content type for the stream

func WithDelimiter

func WithDelimiter(delimiter string) StreamOption

WithDelimiter sets the delimiter for line-based stream reading