httpstream

Oct 26, 2026

Changes in this version

+ var ErrClientWrite = errors.New("httpstream: write to the client failed")

+ func ClientGone(ctx context.Context, err error) bool

+ func Run(ctx context.Context, w http.ResponseWriter, stream provider.Stream, ...)

+ type CompletionStreamer interface

+ CompleteStream func(ctx context.Context, req *provider.CompletionRequest) (provider.Stream, error)

+ type EventType string

+ const EventTypeAudio

+ const EventTypeCitation

+ const EventTypeDelta

+ const EventTypeDone

+ const EventTypeError

+ const EventTypeHeartbeat

+ const EventTypeImage

+ const EventTypeReasoning

+ const EventTypeToolCall

+ const EventTypeUsage

+ type NDJSONEncoder struct

+ func NewNDJSONEncoder() *NDJSONEncoder

+ func (e *NDJSONEncoder) ContentType() string

+ func (e *NDJSONEncoder) EncodeError(w io.Writer, werr *WireError) error

+ func (e *NDJSONEncoder) EncodeEvent(w io.Writer, ev *StreamEvent) error

+ func (e *NDJSONEncoder) End(w io.Writer) error

+ func (e *NDJSONEncoder) Heartbeat(w io.Writer) error

+ func (e *NDJSONEncoder) WriteHeaders(w http.ResponseWriter)

+ type Registry struct

+ func DefaultRegistry() *Registry

+ func NewRegistry() *Registry

+ func (r *Registry) Default() StreamEncoder

+ func (r *Registry) Lookup(name string) StreamEncoder

+ func (r *Registry) Register(contentType string, enc StreamEncoder)

+ func (r *Registry) RegisterAlias(alias, contentType string)

+ func (r *Registry) SetDefault(contentType string)

+ type RunOptions struct

+ HeartbeatInterval time.Duration

+ OnError func(error)

+ RequestID string

+ type SSENativeEncoder struct

+ func NewSSENativeEncoder() *SSENativeEncoder

+ func (e *SSENativeEncoder) ContentType() string

+ func (e *SSENativeEncoder) EncodeError(w io.Writer, werr *WireError) error

+ func (e *SSENativeEncoder) EncodeEvent(w io.Writer, ev *StreamEvent) error

+ func (e *SSENativeEncoder) End(w io.Writer) error

+ func (e *SSENativeEncoder) Heartbeat(w io.Writer) error

+ func (e *SSENativeEncoder) WriteHeaders(w http.ResponseWriter)

+ type SSEOpenAIEncoder struct

+ func NewSSEOpenAIEncoder() *SSEOpenAIEncoder

+ func (e *SSEOpenAIEncoder) ContentType() string

+ func (e *SSEOpenAIEncoder) EncodeError(w io.Writer, werr *WireError) error

+ func (e *SSEOpenAIEncoder) EncodeEvent(w io.Writer, ev *StreamEvent) error

+ func (e *SSEOpenAIEncoder) End(w io.Writer) error

+ func (e *SSEOpenAIEncoder) Heartbeat(w io.Writer) error

+ func (e *SSEOpenAIEncoder) WriteHeaders(w http.ResponseWriter)

+ type StreamEncoder interface

+ ContentType func() string

+ EncodeError func(w io.Writer, err *WireError) error

+ EncodeEvent func(w io.Writer, e *StreamEvent) error

+ End func(w io.Writer) error

+ Heartbeat func(w io.Writer) error

+ WriteHeaders func(w http.ResponseWriter)

+ func Negotiate(r *http.Request, reg *Registry) StreamEncoder

+ type StreamEvent struct

+ Audio *provider.AudioChunk

+ Citation *provider.Citation

+ Delta *provider.Delta

+ Err *WireError

+ FinishReason string

+ ID string

+ Image *provider.ImageChunk

+ Model string

+ RequestID string

+ Type EventType

+ Usage *provider.Usage

+ func FromChunk(c *provider.StreamChunk, requestID string) *StreamEvent

+ type WSHandler struct

+ func NewWSHandler(streamer CompletionStreamer, opts WSOptions) *WSHandler

+ func (h *WSHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type WSOptions struct

+ AcceptOrigins []string

+ HeartbeatInterval time.Duration

+ OnError func(ctx context.Context, err error)

+ SendBuffer int

+ type WireError struct

+ Code string

+ Message string

+ RequestID string

+ Retryable bool

+ Type string

+ func SanitizeError(err error, requestID string) *WireError