response.go


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

package gus

import "io"

// Status is the integer status code of a response.
type Status int

// Response contains the data in a response over the small web.
//
// Because protocols have so many differences, this type represents a
// greatest common denominator of request/response-oriented protocols.
type Response struct {
	// Status is the status code of the response.
	Status Status

	// Meta contains status-specific additional information.
	Meta any

	// Body is the response body, if any.
	Body io.Reader
}

func (response *Response) Close() error {
	if cl, ok := response.Body.(io.Closer); ok {
		return cl.Close()
	}
	return nil
}

// ResponseReader is an object which can serialize a response to a protocol.
type ResponseReader interface {
	io.Reader
	io.WriterTo
	io.Closer
}