response

Documentation

Index

• Variables
• func JSON(w http.ResponseWriter, data any)
• func PrepareTemplate(templateFiles embed.FS) *template.Template
• func Template(tmpl *template.Template, w http.ResponseWriter, templateName string, data any)
• func WebSocket(handler func(*WebSocketConnection)) http.Handler
• type StreamResponse
  • func Stream(w http.ResponseWriter, r *http.Request) *StreamResponse
  • func (s *StreamResponse) Closed() bool
  • func (s *StreamResponse) Send(message string) error
  • func (s *StreamResponse) SendEvent(eventName, message string) error
• type WebSocketConnection
  • func (ws *WebSocketConnection) Close() error
  • func (ws *WebSocketConnection) Read() (string, error)
  • func (ws *WebSocketConnection) ReadBytes() ([]byte, error)
  • func (ws *WebSocketConnection) ReadMessage() (WebSocketMessage, error)
  • func (ws *WebSocketConnection) Send(msg string) error
  • func (ws *WebSocketConnection) SendBytes(data []byte) error
  • func (ws *WebSocketConnection) WritePing(payload []byte) error
  • func (ws *WebSocketConnection) WritePong(payload []byte) error
• type WebSocketMessage

Variables

var ErrStreamClosed = errors.New("stream closed")

ErrStreamClosed is returned when a write is attempted on a closed stream.

Functions

func JSON

func JSON(w http.ResponseWriter, data any)

func PrepareTemplate

func PrepareTemplate(templateFiles embed.FS) *template.Template

Removes the top-level folder, as well as file extensions. Panics on errors.

//go:embed templates
var templateFiles embed.FS
var tmpls = response.PrepareTemplate(templateFiles)
response.Template(tmpls, w, "template name", data)

func Template

func Template(tmpl *template.Template, w http.ResponseWriter, templateName string, data any)

func WebSocket

func WebSocket(handler func(*WebSocketConnection)) http.Handler

Types

type StreamResponse

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

func Stream

func Stream(w http.ResponseWriter, r *http.Request) *StreamResponse

Turns a long-running operation into a server-sent event stream

func (*StreamResponse) Closed

func (s *StreamResponse) Closed() bool

func (*StreamResponse) Send

func (s *StreamResponse) Send(message string) error

func (*StreamResponse) SendEvent

func (s *StreamResponse) SendEvent(eventName, message string) error

type WebSocketConnection

type WebSocketConnection struct {
	// MaxMessageSize caps the total size of a reassembled (possibly fragmented)
	// message. Defaults to 16 MB
	MaxMessageSize int64
	// contains filtered or unexported fields
}

WebSocketConnection is a single upgraded WebSocket connection

func (*WebSocketConnection) Close

func (ws *WebSocketConnection) Close() error

func (*WebSocketConnection) Read

func (ws *WebSocketConnection) Read() (string, error)

Must be called from a single goroutine only

func (*WebSocketConnection) ReadBytes

func (ws *WebSocketConnection) ReadBytes() ([]byte, error)

Must be called from a single goroutine only

func (*WebSocketConnection) ReadMessage

func (ws *WebSocketConnection) ReadMessage() (WebSocketMessage, error)

Must be called from a single goroutine only

func (*WebSocketConnection) Send

func (ws *WebSocketConnection) Send(msg string) error

Safe for concurrent use

func (*WebSocketConnection) SendBytes

func (ws *WebSocketConnection) SendBytes(data []byte) error

Safe for concurrent use

func (*WebSocketConnection) WritePing

func (ws *WebSocketConnection) WritePing(payload []byte) error

WritePing sends a ping control frame with an optional payload (<=125 bytes).

func (*WebSocketConnection) WritePong

func (ws *WebSocketConnection) WritePong(payload []byte) error

WritePong sends a pong control frame, normally in response to a ping.

type WebSocketMessage

type WebSocketMessage struct {
	Payload  []byte
	IsBinary bool
}